Top
You are looking at an outdated 7.12.0 version of this document. Switch to the 7.13.0 version to see the up to date information.

class anychart.core.axisMarkers.CircularRange Improve this Doc

Extends: anychart.core.VisualBase

Bar pointer class.

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 axis index.

Returns:

number - Current axis index.

Try it:

Setter for 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 - 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.

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.VisualBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

Try it:

endSize

Getter for range end size.

Returns:

string - Current range end size.

Try it:

Setter for range end size.

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 range fill.

Returns:

anychart.graphics.vector.Fill - Current range fill settings.
Setter for range fill.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
{color: "#008000", opacity: 0.5}
Value to set.

Returns:

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

Try it:

from

Getter for starting range value.

Returns:

number - Current starting range value.

Try it:

Setter for 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.

Params:

Name Type 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 Whether to fire in capture phase (defaults to false).
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.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope Object Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

position

Getter for range position.

Returns:

anychart.enums.GaugeSidePosition string - Current range position.

Try it:

Setter for range position.

Params:

Name Type Default Description
value anychart.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:

Name Type Default Description
paperSize anychart.graphics.vector.PaperSize
Paper size.
landscape boolean
false
Flag of landscape.

Try it:

radius

Getter for range radius.

Returns:

string - Current range radius.

Try it:

Setter for range 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 range start size.

Returns:

string - Current range start size.

Try it:

Range start size.

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 ending range value.

Returns:

number - Current ending range value.

Try it:

Setter for 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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
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.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it: