class anychart.core.axes.Circular Improve this Doc

Circular axis class. Learn more about circular axis.

Methods Overview

Specific settings
cornersRounding()	Rounding of corners
minorTicks()	Minor ticks settings.
scale()	Scale settings.
startAngle()	Start angle settings.
sweepAngle()	Sweep angle.
ticks()	Ticks settings.
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).
Labels
drawFirstLabel()	Drawing of the first label
drawLastLabel()	Drawing of the last label
labels()	Labels settings.
minorLabels()	Minor labels settings.
overlapMode()	Overlap mode for labels.
Size and Position
radius()	Axis radius.
width()	Axis width.
zIndex()	Z-index of the element.

Methods Description

cornersRounding

cornersRounding()Since version 7.11.0

Getter for the rounding of corners.

Returns:

string - The radius of corners rounding in percent.

Try it:

Usage sample

cornersRounding(value)Since version 7.11.0

Setter for the rounding of corners. Round off the ends of axes to the specified radius.

Params:

Name	Type	Default	Description
value	null \| number \| string	"0%"	Radius for rounding of corners

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

drawFirstLabel

drawFirstLabel()

Getter for the first label drawing flag.

Returns:

boolean - Drawing flag.

Try it:

Usage sample

drawFirstLabel(value)

Setter for the first label drawing flag.

Params:

Name	Type	Default	Description
value	boolean	true	Drawing flag.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

drawLastLabel

drawLastLabel()

Getter for the last label drawing flag.

Returns:

boolean - Drawing flag.

Try it:

Usage sample

drawLastLabel(value)

Setter for the last label drawing flag.

Params:

Name	Type	Default	Description
value	boolean	true	Drawing flag.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

enabled

enabled()

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

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

fill

fill()

Getter for the axis fill color.

Returns:

anychart.graphics.vector.Fill - Axis fill color.

Try it:

Usage sample

fill(value)

Setter for axis fill settings using an array or a string. Learn more about coloring.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Fill \| string	"#CECECE"	Color as an object or a string.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

fill(color, opacity)

Axis fill color with opacity. Fill as a string or an object.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

Name	Type	Description
color	string	Color as a string.
opacity	number	Color opacity.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

fill(keys, angle, mode, opacity)

Linear gradient axis fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Gradient keys.
angle	number	Gradient angle.
mode	boolean \| anychart.graphics.vector.Rect \| Object	Gradient mode.
opacity	number	Gradient opacity.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)

Radial axis fill. Learn more about coloring.

Params:

Name	Type	Description
keys	Array.<(anychart.graphics.vector.GradientKey\|string)>	Color-stop gradient keys.
cx	number	X ratio of center radial gradient.
cy	number	Y ratio of center radial gradient.
mode	anychart.graphics.math.Rect	If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity	number	Opacity of the gradient.
fx	number	X ratio of focal point.
fy	number	Y ratio of focal point.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

fill(imageSettings)

Image axis fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

labels

labels()

Getter for labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels.

Try it:

Usage sample

labels(value)

Setter for 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
value	Object \| boolean \| null	true	Labels settings.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

listen

listen(type, listener, useCapture, listenerScope)

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.

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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

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).

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:

Usage sample

minorLabels

minorLabels()

Getter for minor labels.

Returns:

anychart.core.ui.LabelsFactory - Axis minor labels.

Try it:

Usage sample

minorLabels(value)

Setter for minor labels.

Detailed description

Sets minor labels settings depending on parameter type:

null/boolean - disable or enable minor labels.
object - sets minor labels settings.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	false	Minor labels settings.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

minorTicks

minorTicks()

Getter for minor axis ticks.

Returns:

anychart.core.axes.CircularTicks - Minor ticks.

Try it:

Usage sample

minorTicks(value)

Setter for minor axis ticks.

Detailed description

Sets minor axis ticks settings depending on parameter type:

null/boolean - disable or enable minor axis ticks.
object - sets minor axis ticks settings.

Params:

Name	Type	Default	Description
value	Object \| boolean \| null	false	Minor ticks settings.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

overlapMode

overlapMode()

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode | string - Overlap mode.

Try it:

Usage sample

overlapMode(value)

Setter for labels overlap mode.

Params:

Name	Type	Default	Description
value	anychart.enums.LabelsOverlapMode \| string \| boolean	"noOverlap"	Value to set.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

print

print(paperSizeOrOptions, landscape)

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:

Usage sample

radius

radius()

Getter for the axis radius.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

string - The axis radius.

Try it:

Usage sample

radius(value)

Setter for the axis radius.

Detailed description

Null returns auto calculated bar pointer radius.

Params:

Name	Type	Default	Description
value	null \| number \| string	undefined	Value to set.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

scale

scale()

Getter for the axis scale.

Returns:

anychart.scales.Linear | anychart.scales.Logarithmic - The axis scale.

Try it:

Usage sample

scale(value)

Setter for the axis scale.

Detailed description

Use anychart.scales.ScatterBase#maximum and anychart.scales.ScatterBase#minimum methods to set scale.

Params:

Name	Type	Description
value	anychart.enums.GaugeScaleTypes \| anychart.scales.Linear \| anychart.scales.Logarithmic \| string	Scale to set.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

startAngle

startAngle()

Getter for the start angle.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

number - The start angle.

Try it:

Usage sample

startAngle(value)

Setter for the start angle.

Detailed description

Null returns auto calculated bar pointer radius.

Params:

Name	Type	Default	Description
value	null \| string \| number	null	Value to set.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

sweepAngle

sweepAngle()

Getter for the sweep angle.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

number - The sweep angle.

Try it:

Usage sample

sweepAngle(value)

Setter for the sweep angle.

Params:

Name	Type	Default	Description
value	null \| string \| number	undefined	Value to set.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

Usage sample

ticks

ticks()

Getter for circular ticks.

Returns:

anychart.core.axes.CircularTicks - Axis ticks.

Try it:

Usage sample

ticks(value)

Setter for circular ticks.

Detailed description

Learn more about circular ticks.
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
value	Object \| boolean \| null	true	Ticks settings.

Returns:

anychart.core.axes.Circular - Self instance for method chaining.

Try it:

unlisten

unlisten(type, listener, useCapture, listenerScope)

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.