IAxisLabelSettings

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

Default 0.19


Inherited from ILabelSettings

How mouch of the height should be considered to go below baseline.

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 | false | true

Default false


Inherited from ILabelSettings

Whether words can be broken when truncating or wrapping text.

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 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 DateFormatter | undefined

Inherited from ISpriteSettings

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

Click here for more info

Type "ltr" | "rtl"

Default "ltr"


Inherited from ILabelSettings

Text direction.

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 | string

Default "…"


Inherited from ILabelSettings

Ellipsis characters to use when truncating text.

Will use Unicode ellipsis symbol ("…") by default, which might not be available in all fonts. If ellipsis looks broken, use different characters. E.g.:

label.set("ellipsis", "...");

label.set("ellipsis", "...");

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 ILabelSettings

Text color.

Type undefined | number

Default 1

Inherited from ILabelSettings

Text opacity.

@ince 5.2.39

Type undefined | string

Inherited from ILabelSettings

Font family to use for the label.

Multiple fonts can be separated by commas.

Type string | number

Inherited from ILabelSettings

Font size in misc any supported CSS format (pixel, point, em, etc.).

Type "normal" | "italic" | "oblique"

Inherited from ILabelSettings

Font style.

Type "normal" | "small-caps"

Inherited from ILabelSettings

Font variant.

Type "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900"

Inherited from ILabelSettings

Font weight.

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 number | Percent | null

Inherited from ISpriteSettings

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

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 | false | true

Default false


Inherited from ILabelSettings

If set to true, will ignore in-line formatting blocks and will display text exactly as it is.

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 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 Percent | number

Inherited from ILabelSettings

Line height in percent or absolute pixels.

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 undefined | number

Inherited from ILabelSettings

Maximum number of characters to allow in label.

If the text is longer than maxChars, the text will be truncated using the breakWords and ellipsis settings.

@since 5.7.2

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

Inherited from ILabelSettings

Minimum relative scale allowed for label when scaling down when oversizedBehavior is set to "fit".

If fitting the label would require it to scale beyond minScale it would be hidden instead.

Type number | null

Inherited from ISpriteSettings

Minimum allowed width 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 ILabelSettings

Opacity of the label.

0 - fully transparent; 1 - fully opaque.

Type "none" | "hide" | "fit" | "wrap" | "wrap-no-break" | "truncate"

Inherited from ILabelSettings

How to handle labels that do not fit into its designated space.

LIMITATIONS: on circular labels, the only values supported are "hide" and "truncate". The latter will ignore breakWords setting.

Click here for more info

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 undefined | false | true

Inherited from ILabelSettings

If set to true the label will parse text for data placeholders and will try to populate them with actual data.

Click here for more info

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 | 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 undefined | number

Inherited from ILabelSettings

Blurriness of the the shadow.

The bigger the number, the more blurry shadow will be.

Click here for more info

Type Color | null

Inherited from ILabelSettings

Color of the element's shadow.

For this to work at least one of the following needs to be set as well:

shadowBlur, shadowOffsetX, shadowOffsetY.

Click here for more info

Type undefined | number

Inherited from ILabelSettings

Horizontal shadow offset in pixels.

Click here for more info

Type undefined | number

Inherited from ILabelSettings

Vertical shadow offset in pixels.

Click here for more info

Type undefined | number

Inherited from ILabelSettings

Opacity of the shadow (0-1).

If not set, will use the same as fillOpacity of the element.

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 | 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 undefined | string

Inherited from ISpriteSettings

Allows binding element's settings to data.

Click here for more info

Type undefined | string

Inherited from ILabelSettings

Labels' text.

Click here for text styling info

Type "start" | "end" | "left" | "right" | "center"

Inherited from ILabelSettings

Alignment.

Type "top" | "hanging" | "middle" | "alphabetic" | "ideographic" | "bottom"

Inherited from ILabelSettings

A base line to use when aligning text chunks vertically.

Type "underline" | "line-through"

Inherited from ILabelSettings

Text decoration.

Supported options "underline", "line-through".

@since 5.0.15

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 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.