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:

Name Type Default Description
enabled boolean | null
true
Whether to enable level.

Returns:

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

Try it:

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Setter for hovered state settings.

Params:

Name Type Description
settings Object State settings to set.

Returns:

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

Try it:

labels

Getter for labels settings.

Returns:

anychart.core.ui.LabelsFactory - LabelsFactory instance.

Try it:

Setter for the labels settings.

Params:

Name Type Default Description
settings Object | 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:

Name Type Default Description
type string
The event type id.
listener function(Object e)
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(Object e)
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:

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Setter for normal state settings.

Params:

Name Type Description
settings Object State settings to set.

Returns:

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

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:

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Setter for selected state settings.

Params:

Name Type Description
settings Object State settings to set.

Returns:

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

Try it:

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:

Name Type Description
thickness string | number Thickness to set.

Returns:

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

Try it:

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: