AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 8.0.1 version of this document. Switch to the 8.4.0 version to see the up to date information.

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

Getter for the axis index.

Returns:

number - Axis index.
Setter for the axis index.

Params:

NameTypeDefaultDescription
indexnumber
0
Value to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.

cornersRounding

Getter for the rounding of circular ranges.

Returns:

string - The radius of circular ranges rounding in percent.
Setter for the rounding of circular ranges.
Round off the ends of circular ranges to the specified radius.

Params:

NameTypeDefaultDescription
valuenull | number | string
"0%"
Radius for rounding of circular ranges.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

endSize

Getter for the range end size.

Returns:

string - Range end size.
Setter for the range end size.

Params:

NameTypeDefaultDescription
valuenull | number | string
"10%"
Value to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.

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:

NameTypeDefaultDescription
valueanychart.graphics.vector.Fill
{color: "#7c868e", opacity: 0.7}
Value to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.

from

Getter for the starting range value.

Returns:

number - The starting range value.
Setter for the starting range value.

Params:

NameTypeDescription
valuenumberValue to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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 }.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

position

Getter for the range position.

Returns:

anychart.enums.GaugeSidePosition | string - Range position.
Setter for the range position.

Params:

NameTypeDefaultDescription
valueanychart.enums.GaugeSidePosition | string
"center"
Value to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

radius

Getter for the range radius.

Returns:

string - Range radius.
Setter for the range radius.

Params:

NameTypeDefaultDescription
valuenumber | string | null
undefined
Value to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

startSize

Getter for the range start size.

Returns:

string - Range start size.
Setter for the range start size.

Params:

NameTypeDefaultDescription
valuenull | number | string
"0%"
Value to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.

to

Getter for the ending range value.

Returns:

number - The ending range value.
Setter for the ending range value.

Params:

NameTypeDescription
valuenumberValue to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

anychart.core.axisMarkers.CircularRange - Self instance for method chaining.