class anychart.core.axisMarkers.CircularRange Improve this Doc
Extends: anychart.core.VisualBase
Circular range.
Methods Overview
| Specific settings | |
| axisIndex() | Axis index. |
| cornersRounding() | The rounding of circular ranges |
| Coloring | |
| fill() | Fill settings. |
| Interactivity | |
| enabled() | Element state (enabled or disabled). |
| Size and Position | |
| endSize() | Size for end range. |
| from() | Starting range value. |
| position() | Range position. |
| radius() | Range radius. |
| startSize() | Size for start range. |
| to() | Ending range value. |
| zIndex() | Z-index of the element. |
Methods Description
axisIndex
Setter for the axis index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Axis index to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
cornersRounding
Getter for the rounding of circular ranges.
Returns:
string - The radius of circular ranges rounding in percent.Try it:
Setter for the rounding of circular ranges.
Round off the ends of circular ranges to the specified radius.
Round off the ends of circular ranges to the specified radius.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | number | string | '0%' | Radius for rounding of circular ranges. |
Returns:
anychart.core.axisMarkers.CircularRange - 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.core.axisMarkers.CircularRange - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
endSize
Getter for the range end size.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string - Range end size.Try it:
Setter for the range end size.
Detailed description
Null returns auto calculated end width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | number | string | '10%' | Value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
fill
Getter for the range fill.
Returns:
anychart.graphics.vector.Fill - Range fill settings. See listing
var range = chart.range(); var fill = range.fill();
Setter for range fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | {color: '#7c868e', opacity: 0.7} | Color as an array, an object or a string. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.from
Getter for the starting range value.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
number - The starting range value.Try it:
Setter for the starting range value.
Params:
| Name | Type | Description |
|---|---|---|
| fromValue | number | 'From' value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
position
Getter for the range position.
Returns:
anychart.enums.GaugeSidePosition | string - Range position.Try it:
Setter for the range position.
Detailed description
Range position relative axis - inside, center, outside.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| positionType | anychart.enums.GaugeSidePosition | string | 'center' | Value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
radius
Getter for the range radius.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string - Range radius.Try it:
Setter for the range radius.
Detailed description
Sets relative gauge radius in percent. Null returns auto calculated end radius.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | undefined | Radius to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
startSize
Getter for the range start size.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
string - Range start size.Try it:
Setter for the range start size.
Detailed description
Null returns auto calculated end width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | number | string | '0%' | Value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
to
Getter for the ending range value.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
number - The ending range value.Try it:
Setter for the ending range value.
Params:
| Name | Type | Description |
|---|---|---|
| toValue | number | 'To' value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
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.core.axisMarkers.CircularRange - Self instance for method chaining.Try it: