AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.standalones.axes.Radial Improve this Doc

Extends: anychart.core.axes.Radial

The Radial class contains methods for configuring standalones Radial axes.
This class allow to create custom Radial axes or add them to charts.

Methods Overview

Specific settings
drawFirstLabel()Drawing of the first label.
drawLastLabel()Drawing of the last label.
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
innerRadius()Inner radius for the radial axis.
parentBounds()Parent bounds for the radial axis.
startAngle()Start angle for the radial axis.
zIndex()Z-index of the element.
Miscellaneous
container()Container for the radial axis.
draw()Drawing of the radial axis.

Methods Description

container

Getter for the axis container.
Setter for the axis container.

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementThe value to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

draw

Drawing of the radial axis.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

drawFirstLabel

Getter for the first label drawing flag.

Returns:

boolean - Drawing flag.
See listing
var yAxis = chart.yAxis();
var flag = yAxis.drawFirstLabel();
Setter for the first label drawing flag.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

drawLastLabel

Getter for the last label drawing flag.

Returns:

boolean - Drawing flag.
See listing
var yAxis = chart.yAxis();
var flag = yAxis.drawLastLabel();
Setter for the last label drawing flag.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

enabled

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

innerRadius

Getter for the inner radius.

Returns:

string | number - Inner radius.
Setter for the inner radius.

Params:

NameTypeDescription
valuestring | numberValue to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

labels

Getter for axis labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels.
Setter for axis labels.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Axis labels.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
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(e:Object)
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.

minorLabels

Getter for axis minor labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels.
Setter for axis minor labels.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Value to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

minorTicks

Getter for axis minor ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.
Setter for axis minor ticks.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Value to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

overlapMode

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode | string - Overlap mode.
Setter for labels overlap mode for.

Params:

NameTypeDefaultDescription
modeanychart.enums.LabelsOverlapMode | string
'noOverlap'
Value to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

parentBounds

Getter for bounds.

Returns:

anychart.math.Rect - Axis parent bounds.
Setter for bounds using single value.

Params:

NameTypeDescription
valueanychart.math.Rect | Object | nullValue to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.
Setter for bounds using several values.

Params:

NameTypeDescription
leftnumberLeft space.
topnumberTop space.
widthnumberWidth axis.
heightnumberHeight axis.

Returns:

anychart.standalones.axes.Radial - 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.

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.

scale

Getter for the axis scale.

Returns:

anychart.scales.Base - Axis scale.
Setter for the axis scale.

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Scale settings to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

startAngle

Getter for a start angle.

Returns:

string | number - The start angle.
Setter for a start angle.

Params:

NameTypeDefaultDescription
anglestring | number
0
Start angle to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

stroke

Getter for the axis stroke.

Returns:

anychart.graphics.vector.Stroke - Axis stroke settings.
See listing
var yAxis = chart.yAxis();
var strokeSettings = yAxis.stroke();
Setter for the axis stroke. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'#CECECE'
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line joint style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.
Setter for axis stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

ticks

Getter for axis ticks.

Returns:

anychart.core.axes.Ticks - Axis ticks.
Setter for axis ticks.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Value to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
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 Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

anychart.standalones.axes.Radial - Self instance for method chaining.