class anychart.standalones.axes.Radial Improve this Doc
Extends: anychart.core.axes.Radial
The Radial class contains methods for configuring standalones Radial axes.
This class allow to create custom Radial axes or add them to charts.
Methods Overview
| Specific settings | |
| drawFirstLabel() | Drawing of the first label. |
| drawLastLabel() | Drawing of the last label. |
| labels() | Labels settings. |
| minorLabels() | Minor labels settings. |
| minorTicks() | Minor ticks settings. |
| overlapMode() | Overlap mode for labels. |
| scale() | Scale settings. |
| ticks() | Ticks settings. |
| Coloring | |
| stroke() | Stroke settings. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| Size and Position | |
| innerRadius() | Inner radius for the radial axis. |
| parentBounds() | Parent bounds for the radial axis. |
| startAngle() | Start angle for the radial axis. |
| zIndex() | Z-index of the element. |
| Miscellaneous | |
| container() | Container for the radial axis. |
| draw() | Drawing of the radial axis. |
Methods Description
container
Getter for the axis container.
Setter for the axis container.
Params:
| Name | Type | Description |
|---|---|---|
| element | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
draw
Drawing of the radial axis.
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
drawFirstLabel
Getter for the first label drawing flag.
Returns:
boolean - Drawing flag. See listing
var yAxis = chart.yAxis(); var flag = yAxis.drawFirstLabel();
Setter for the first label drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
drawLastLabel
Getter for the last label drawing flag.
Returns:
boolean - Drawing flag. See listing
var yAxis = chart.yAxis(); var flag = yAxis.drawLastLabel();
Setter for the last label drawing flag.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
innerRadius
Getter for the inner radius.
Returns:
string | number - Inner radius.Setter for the inner radius.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | number | Value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.labels
Setter for axis labels.
Detailed description
Sets axis labels settings depending on parameter type:
- null/boolean - disable or enable axis labels.
- object - sets axis labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Axis labels. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.minorLabels
Setter for axis minor labels.
Detailed description
Sets axis minor labels settings depending on parameter type:
- null/boolean - disable or enable axis minor labels.
- object - sets axis minor labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.minorTicks
Setter for axis minor ticks.
Detailed description
Sets axis minor ticks settings depending on parameter type:
- null/boolean - disable or enable axis minor ticks.
- object - sets axis minor ticks settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.overlapMode
Getter for labels overlap mode.
Returns:
anychart.enums.LabelsOverlapMode | string - Overlap mode.Setter for labels overlap mode for.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| mode | anychart.enums.LabelsOverlapMode | string | 'noOverlap' | Value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
parentBounds
Getter for bounds.
Returns:
anychart.math.Rect - Axis parent bounds.Setter for bounds using single value.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.math.Rect | Object | null | Value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
Setter for bounds using several values.
Params:
| Name | Type | Description |
|---|---|---|
| left | number | Left space. |
| top | number | Top space. |
| width | number | Width axis. |
| height | number | Height axis. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
scale
Setter for the axis scale.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | anychart.scales.Base | Object | anychart.enums.ScaleTypes | string | anychart.scales.Linear | Scale settings to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
startAngle
Getter for a start angle.
Returns:
string | number - The start angle.Setter for a start angle.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| angle | string | number | 0 | Start angle to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
stroke
Getter for the axis stroke.
Returns:
anychart.graphics.vector.Stroke - Axis stroke settings. See listing
var yAxis = chart.yAxis(); var stroke = yAxis.stroke();
Setter for the axis stroke.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | '#CECECE' | Stroke settings. |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | string | anychart.graphics.vector.StrokeLineJoin | Line joint style. | |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
Setter for axis stroke settings using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Object with stroke settings from anychart.graphics.vector.Stroke |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it:
ticks
Setter for axis ticks.
Detailed description
Sets axis ticks settings depending on parameter type:
- null/boolean - disable or enable axis ticks.
- object - sets axis ticks settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.zIndex
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| zIndex | number | 0 | Value to set. |
Returns:
anychart.standalones.axes.Radial - Self instance for method chaining.Try it: