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. |
| Events | |
| listen() | Adds an event listener. |
| listenOnce() | Adds a single time event listener. |
| removeAllListeners() | Removes all listeners. |
| unlisten() | Removes the listener. |
| unlistenByKey() | Removes the listener by the key. |
| Export | |
| print() | Prints all elements. |
| 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 | Value 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 current element state (enabled or disabled).
Returns:
boolean - The current element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | true | Value 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 currentFill = range.fill();
Setter for the range fill.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Fill | {color: "#7c868e", opacity: 0.7} | Value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
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 |
|---|---|---|
| value | number | Value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
listen
Adds an event listener to an implementing object.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. Function that looks like function(event){
// event.actualTarget - actual event target
// event.currentTarget - current event target
// event.iterator - event iterator
// event.originalEvent - original event
// event.point - event point
// event.pointIndex - event point index
}. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
Adds an event listener to an implementing object.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.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 |
|---|---|---|---|
| value | anychart.enums.GaugeSidePosition | string | "center" | Value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
Prints all elements on related stage.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| paperSizeOrOptions | anychart.graphics.vector.PaperSize | Object | Paper size or object with options. | |
| landscape | boolean | false | Flag of landscape. |
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 | Value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
removeAllListeners
Removes all listeners from an object. You can also optionally remove listeners of some particular type.
Params:
| Name | Type | Description |
|---|---|---|
| type | string | Type of event to remove, default is to remove all types. |
Returns:
number - Number of listeners removed.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 |
|---|---|---|
| value | number | Value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it:
unlisten
Removes a listener added using listen() or listenOnce() methods.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
Params:
| Name | Type | Description |
|---|---|---|
| key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
zIndex
Getter for the current Z-index of the element.
Returns:
number - The current zIndex.Try it:
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 |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.core.axisMarkers.CircularRange - Self instance for method chaining.Try it: