class anychart.core.axes.Polar Improve this Doc

Polar axis class.

Methods Overview

Specific settings
labels()	Labels settings.
minorLabels()	Minor labels settings.
minorTicks()	Minor ticks settings.
overlapMode()	Overlap mode for labels.
scale()	Scale settings.
ticks()	Ticks settings.
Coloring
stroke()	Stroke 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
getRemainingBounds()	Returns remaining parent bounds to use elsewhere.
zIndex()	Z-index of the element.

Methods Description

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.

getRemainingBounds

getRemainingBounds()

Returns remaining parent bounds to use elsewhere.

Returns:

anychart.math.Rect - Parent bounds without the space used by the title.

Try it:

Usage sample

labels

labels()

Getter for axis labels.

Returns:

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

Try it:

Usage sample

labels(value)

Setter for axis 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	Axis labels.

Returns:

anychart.core.axes.Polar - 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	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:

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	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:

Usage sample

minorLabels

minorLabels()

Getter for axis minor labels.

Returns:

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

Try it:

Usage sample

minorLabels(value)

Setter for axis minor labels.

Detailed description

Sets axis minor labels settings depending on parameter type:

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

Params:

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

Returns:

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

Try it:

minorTicks

minorTicks()

Getter for minor axis ticks.

Returns:

anychart.core.axes.RadialTicks - Axis ticks.

Try it:

Usage sample

minorTicks(value)

Setter for minor axis ticks.

Detailed description

Sets axis minor ticks settings depending on parameter type:

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

Params:

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

Returns:

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

Try it:

overlapMode

overlapMode()

Getter for overlap mode for labels.

Returns:

anychart.enums.LabelsOverlapMode string - Overlap mode flag.

overlapMode(value)

Setter for overlap mode for labels.

Params:

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

Returns:

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

Try it:

Usage sample

print

print(paperSize, landscape)

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:

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

Returns:

anychart.scales.ScatterBase - Axis scale.

scale(value)

Setter for axis scale.

Params:

Name	Type	Description
value	anychart.scales.ScatterBase	Value to set.

Returns:

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

Try it:

Usage sample

stroke

stroke()

Getter for axis stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axis line stroke settings.

stroke(value, thickness, dashpattern, lineJoin, lineCap)

Setter for axis stroke settings. Learn more about stroke settings.

Params:

Name	Type	Default	Description
value	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null	"#eaeaea"	Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

ticks

ticks()

Getter for axis ticks.

Returns:

anychart.core.axes.RadialTicks - Axis ticks.

Try it:

Usage sample

ticks(value)

Setter for axis ticks.

Detailed description

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	false	Axis ticks.

Returns:

anychart.core.axes.Polar - 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	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.