Top

class anychart.core.axes.Polar Improve this Doc

Extends: anychart.core.VisualBase

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

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:

getRemainingBounds

Returns remaining parent bounds to use elsewhere.

Returns:

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

Try it:

labels

Getter for axis labels.

Returns:

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

Try it:

Setter for axis labels.

Params:

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

Returns:

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

listen

Adds an event listener to an implementing object.

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.

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:

minorLabels

Getter for axis minor labels.

Returns:

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

Try it:

Setter for axis minor labels.

Params:

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

Returns:

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

minorTicks

Getter for minor axis ticks.

Returns:

anychart.core.axes.RadialTicks - Axis ticks.

Try it:

Setter for minor axis ticks.

Params:

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

Returns:

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

overlapMode

Getter for labels overlap mode for.

Returns:

anychart.enums.LabelsOverlapMode string - Overlap mode.
See listing
var xAxis = chart.xAxis();
var mode = xAxis.overlapMode();
Setter for labels overlap mode.

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:

print

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:

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:

scale

Getter for the axis scale.

Returns:

anychart.scales.ScatterBase - Axis scale.

Try it:

Setter for the 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:

stroke

Getter for axis stroke settings.

Returns:

anychart.graphics.vector.Stroke - Axis stroke settings.
See listing
var currentXAxis = chart.xAxis();
var currentStroke = currentXAxis.stroke();
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:

ticks

Getter for axis ticks.

Returns:

anychart.core.axes.RadialTicks - Axis ticks.

Try it:

Setter for axis ticks.

Params:

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

Returns:

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

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.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it: