ISankeySettings

Type undefined | false | true

Inherited from ISpriteSettings

Indicates if element is currently active.

Type Graphics

Inherited from IContainerSettings

Background element.

Click here for more info

Type undefined | number

Inherited from ISpriteSettings

Apply blur filter.

Ranges of values in pixels: 0 to X.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | number

Inherited from ISpriteSettings

Modifty visual brightness.

Range of values: 0 to 1.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | false | true

Inherited from ISeriesSettings

If set to true, series will calculate aggregate values, e.g. change percent, high, low, etc.

Do not enable unless you are using such aggregate values in tooltips, display data fields, heat rules, or similar.

Type number | Percent

Inherited from ISpriteSettings

X coordinate of the center of the element relative to itself.

Center coordinates will affect placement as well as rotation pivot point.

Type number | Percent

Inherited from ISpriteSettings

Y coordinate of the center of the element relative to itself.

Center coordinates will affect placement as well as rotation pivot point.

Type undefined | number

Inherited from ISpriteSettings

Modify contrast.

Range of values: 0 to 1.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | false | true

Default false

Inherited from ISpriteSettings

If set to true, an element will try to draw itself in such way, that it looks crisp on screen, with minimal anti-aliasing.

It will round x/y position so it is positioned fine "on pixel".

It will also adjust strokeWidth based on device pixel ratio or zoom, so the line might look thinner than expected.

NOTE: this is might not universally work, especially when set on several objects that are supposed to fit perfectly with each other.

@since 5.3.0

Type undefined | string

Inherited from ISpriteSettings

A named mouse cursor style to show when hovering this element.

Click here for more info

Type undefined | string

Inherited from ISeriesSettings

A key to look up in data for a numeric customValue of the data item.

Usually used for storing additional numeric information and heat rules.

Type DateFormatter | undefined

Inherited from ISpriteSettings

An instance of DateFormatter that should be used instead of global formatter object.

Click here for more info

Type undefined | false | true

Inherited from ISpriteSettings

Indicates if element is disabled.

Type undefined | false | true

Inherited from ISpriteSettings

If set to true, user will be able to drag this element. It will also disable default drag events over the area of this element.

Type DurationFormatter | undefined

Inherited from ISpriteSettings

An instance of DurationFormatter that should be used instead of global formatter object.

Click here for more info

Type undefined | number

Inherited from ISpriteSettings

Horizontal shift in pixels. Can be negative to shift leftward.

Type undefined | number

Inherited from ISpriteSettings

Vertical shift in pixels. Can be negative to shift upward.

Type undefined | false | true

Inherited from ISpriteSettings

If set to false this element will not appear in exported snapshots of the chart.

Type Color

Inherited from ISeriesSettings

Series fill color.

Click here for more info

Type Pattern

Inherited from ISeriesSettings

Series fill pattern.

Click here for more info
@since 5.10.0

Type undefined | false | true

Inherited from ISpriteSettings

If set to true the element will be hidden regardless of visible or even if show() is called.

Type undefined | false | true

Inherited from ISpriteSettings

If set to true the element will be inactive - absolutely oblivious to all interactions, even if there are related events set, or the interactive: true is set.

@since 5.0.21

Type IHeatRule[]

Inherited from ISeriesSettings

A list of heat rules to apply on series elements.

Click here for more info

Type number | Percent | null

Inherited from ISpriteSettings

Element's absolute height in pixels (numeric value) or relative height to parent (Percent);

Type undefined | number

Default 0.05

Inherited from IFlowSettings

Relative size of hidden links.

Links are hidden when user clicks on nodes (if toggleKey on nodes is set to "disabled").

This allows hidden node to remain visible so that user could click on it again to show it and its links.

Click here for more info
@since 5.4.1

Type undefined | string

Inherited from IContainerSettings

HTML content of the container.

Click here for more info
@since 5.2.11

Type undefined | number

Inherited from ISpriteSettings

Rotate HUE colors in degrees.

Range of values: 0 to 360.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | string

Inherited from IEntitySettings

A custom string ID for the element.

If set, element can be looked up via am5.registry.entitiesById.

Will raise error if an element with the same ID already exists.

Type undefined | string

Inherited from ISeriesSettings

A key to look up in data for an id of the data item.

Type undefined | false | true

Inherited from ISpriteSettings

Should this element accept user interaction events?

Type undefined | false | true

Inherited from IContainerSettings

If set to true all descendants - not just direct children, but every element in it - will become "interactive".

Type undefined | number

Inherited from IComponentSettings

A duration of the animation from one setting value to another, in milliseconds.

Click here for more info

Type $ease.Easing

Inherited from IComponentSettings

Easing function to use for cross setting value animations.

Click here for more info

Type undefined | number

Inherited from ISpriteSettings

Invert colors.

Range of values: 0 (no changes) to 1 (completely inverted colors).

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | false | true

Inherited from ISpriteSettings

If set to false element will not be measured and cannot participate in layout schemes.

Type undefined | number

Inherited from ISpriteSettings

Numeric layer to put element in.

Elements with higher number will appear in front of the ones with lower numer.

If not set, will inherit layer from its ascendants.

Type IMargin

Inherited from ISpriteSettings

Margins for the layer.

Can be used to make the layer larger/or smaller than default chart size.

@since @5.2.39

Type Layout | null

Inherited from IContainerSettings

A method to layout

Click here for more info

Type DataItem

Inherited from ISeriesSettings

A data item representing series in a Legend.

@readonly

Type undefined | string

Inherited from ISeriesSettings

A text template to be used for label in legend.

Type undefined | string

Inherited from ISeriesSettings

A text template to be used for value label in legend.

Type undefined | number

Inherited from ISpriteSettings

Bottom margin in pixels.

Type undefined | number

Inherited from ISpriteSettings

Left margin in pixels.

Type undefined | number

Inherited from ISpriteSettings

Right margin in pixels.

Type undefined | number

Inherited from ISpriteSettings

Top margin in pixels.

Type Graphics | null

Inherited from IContainerSettings

An element to use as a container's mask (clipping region).

Click here for more info

Type undefined | false | true

Inherited from IContainerSettings

If set to true all content going outside the bounds of the container will be clipped.

Type number | null

Inherited from ISpriteSettings

Maximum allowed height in pixels.

Type number | null

Inherited from ISpriteSettings

Maximum allowed width in pixels.

Type number | null

Inherited from ISpriteSettings

Minimum allowed height in pixels.

Type undefined | number

Default 0

Inherited from IFlowSettings

Minimum value of hidden links.

Links are hidden when user clicks on nodes (if toggleKey on nodes is set to "disabled").

Click here for more info
@since 5.4.1

Type undefined | number

Default 0

Inherited from IFlowSettings

Minimum size of the link.

It's a relative value to the sum of all values in the series. If set, this relative value will be used for small value nodes when calculating their size. For example, if it's set to 0.01, small nodes will be sized like their value is 1% of the total sum of all values in series.

@since 5.1.5

Type number | null

Inherited from ISpriteSettings

Minimum allowed width in pixels.

Type undefined | string

Inherited from ISeriesSettings

Name of the series.

Type undefined | number

Default 10


Inherited from IFlowSettings

Minimum gap between adjacent nodes.

Type undefined | number

Default 10


Inherited from IFlowSettings

The thickness of node strip in pixels.

Type NumberFormatter | undefined

Inherited from ISpriteSettings

An instance of NumberFormatter that should be used instead of global formatter object.

Click here for more info

Type undefined | number

Inherited from ISpriteSettings

Opacity. 0 - fully transparent; 1 - fully opaque.

Type undefined | number

Inherited from IContainerSettings

Bottom padding in pixels.

Type undefined | number

Inherited from IContainerSettings

Left padding in pixels.

Type undefined | number

Inherited from IContainerSettings

Right padding in pixels.

Type undefined | number

Inherited from IContainerSettings

Top padding in pixels.

Type "absolute" | "relative"

Inherited from ISpriteSettings

Positioning of the element.

"absolute" means element will not participate in parent layout scheme, and will be positioned solely accoridng its x and y settings.

Type undefined | false | true

Inherited from IContainerSettings

If set to true its children will be laid out in opposite order.

@since 5.1.1

Type undefined | number

Inherited from ISpriteSettings

Rotation in degrees.

Type undefined | number

Inherited from ISpriteSettings

Modify saturation.

Range of values in pixels: 0 to X.

• 0 - grayscale
• 1 - no changes
• >1 - more saturated IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | number

Inherited from ISpriteSettings

Scale.

Setting to a value less than 1 will shrink object.

Type undefined | number

Inherited from ISpriteSettings

Apply sepia filter.

Range of values: 0 (no changes) to 1 (complete sepia).

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | number

Inherited from ISeriesSettings

A delay in milliseconds to wait before starting animation of next data item.

Click here for more info

Type undefined | false | true

Inherited from ISeriesSettings

If set to true the series initial animation will be played item by item rather than all at once.

Click here for more info

Type undefined | false | true

Inherited from IContainerSettings

If set to true, applying a state on a container will also apply the same state on its children.

Click here for more info

Type "hover" | "always" | "click"

Default "hover"

Inherited from ISpriteSettings

Defines when tooltip is shown over the element.

Available options:

• "hover" (default) - tooltip is shown when element is hovered by a pointer or touched. It is hidden as soon as element is not hovered anymore, or touch occurs outside it.
• "always" - a tooltip will always be shown over the element, without any interactions. Please note that if you need to show tooltips for multiple elements at the same time, you need to explicitly create a Tooltip instance and set element's tooltip setting with it.
• '"click"' - a tooltip will only appear when target element is clicked/tapped. Tooltip will hide when clicking anywhere else on the page.

Click here for more info
@since 5.0.16

Type undefined | string

Inherited from IFlowSettings

A field in data which holds source node ID.

Type undefined | number

Inherited from IEntitySettings

Duration of transition from one state to another.

Type $ease.Easing

Inherited from IEntitySettings

Easing of transition from one state to another.

Type Color

Inherited from ISeriesSettings

Series stroke color.

Click here for more info

Type undefined | string

Inherited from IFlowSettings

A field in data which holds target node ID.

Type undefined | string

Inherited from ISpriteSettings

Allows binding element's settings to data.

Click here for more info

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

Click here for more info

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

These tags only apply to this object, not any children.

Click here for more info

Type Array

Inherited from IEntitySettings

A list of themes applied to the element.

Type "disabled" | "active" | "none" | undefined

Inherited from ISpriteSettings

If set, element will toggle specified boolean setting between true and false when clicked/touched.

Type Tooltip

Inherited from ISpriteSettings

Tooltip instance.

Type undefined | string

Inherited from ISpriteSettings

HTML content to show in a tooltip when hovered.

@since 5.2.11

Type "fixed" | "pointer"

Inherited from ISpriteSettings

Tooltip position.

Type undefined | string

Inherited from ISpriteSettings

Text to show in a tooltip when hovered.

Type number | Percent

Inherited from ISpriteSettings

Tooltip pointer X coordinate relative to the element itself.

Type number | Percent

Inherited from ISpriteSettings

Tooltip pointer Y coordinate relative to the element itself.

Type any

Inherited from IEntitySettings

A storage for any custom user data that needs to be associated with the element.

Type undefined | string

Inherited from ISeriesSettings

A key to look up in data for a numeric value of the data item.

Some series use it to display its elements. It can also be used in heat rules.

Type Scrollbar

Inherited from IContainerSettings

Setting this to an instance of Scrollbar will enable vertical scrolling of content if it does not fit into the Container.

Click here for more info

Type undefined | false | true

Inherited from ISpriteSettings

Is element visible?

Type undefined | false | true

Inherited from ISpriteSettings

If set to true, mouse wheel events will be triggered over the element. It will also disable page scrolling using mouse wheel when pointer is over the element.

Type number | Percent | null

Inherited from ISpriteSettings

Element's absolute width in pixels (numeric value) or relative width to parent (Percent);

Type number | Percent | null

Inherited from ISpriteSettings

X position relative to parent.

Type number | Percent | null

Inherited from ISpriteSettings

Y position relative to parent.