AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.sunburst.Level Improve this Doc

Extends: anychart.core.Base

Sunburst level settings.

Methods Overview

Specific settings
enabled()Disable or enable level.
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
Labels
labels()Labels settings.
Size and Position
thickness()Thickness settings.
States
hovered()Hovered state settings.
normal()Normal state settings.
selected()Selected state settings.

Methods Description

enabled

Getter for the enabled state.

Returns:

boolean - Enabled state.
See listing
var level = chart.level(1);
var enabled = level.enabled();
Setter for the enabled state.

Params:

NameTypeDefaultDescription
enabledboolean | null
true
Whether to enable level.

Returns:

anychart.core.sunburst.Level - Self instance for method chaining.

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.sunburst.Level - Self instance for method chaining.

labels

Getter for labels settings.

Returns:

anychart.core.ui.LabelsFactory - LabelsFactory instance.
Setter for the labels settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Chart data labels settings.

Returns:

anychart.core.sunburst.Level - 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.

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.sunburst.Level - Self instance for method chaining.

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.

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings
Setter for selected state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.sunburst.Level - Self instance for method chaining.

thickness

Getter for the level thickness.

Returns:

string | number - The level thickness.
See listing
var level = chart.level(1);
var thickness = level.thickness();
Setter for the level thickness.

Params:

NameTypeDescription
thicknessstring | numberThickness to set.

Returns:

anychart.core.sunburst.Level - 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.