IAxisRendererYSettings

Type undefined | false | true

Inherited from ISpriteSettings

Indicates if element is currently active.

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

Default 1

Inherited from IAxisRendererSettings

Indicates relative position where "usable" space of the cell ends.

0 - beginning, 1 - end, or anything in-between.

Click here for more info

Type undefined | number

Default 0

Inherited from IAxisRendererSettings

Indicates relative position where "usable" space of the cell starts.

0 - beginning, 1 - end, or anything in-between.

Click here for more info

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 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 undefined | ( display: IGraphics, graphics: Graphics) => void

Inherited from IGraphicsSettings

Drawing function.

Must use renderer (display parameter) methods to draw.

Click here for more info

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 IGraphicsSettings

Fill color.

Click here for more information

Type Gradient

Inherited from IGraphicsSettings

Fill gradient.

Click here for more information

Type undefined | number

Inherited from IGraphicsSettings

Opacity of the fill. 0 - fully transparent; 1 - fully opaque.

Type Pattern

Inherited from IGraphicsSettings

Fill pattern.

Click here for more information

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

Inherited from ISpriteSettings

Should this element accept user interaction events?

Type undefined | false | true

Default false

Inherited from IAxisRendererSettings

Set to true to invert direction of the axis.

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 "miter" | "round" | "bevel"

Default "miter"

Inherited from IGraphicsSettings

A method to be used on anchor points (joints) of the multi-point line.

Click here for more info
@since 5.2.10

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

Inherited from ISpriteSettings

Maximum allowed height in pixels.

Type number | null

Inherited from ISpriteSettings

Maximum allowed width in pixels.

Type undefined | number

Inherited from IAxisRendererSettings

The minimum distance between grid lines in pixels.

Click here for more info

Type number | null

Inherited from ISpriteSettings

Minimum allowed height in pixels.

Type number | null

Inherited from ISpriteSettings

Minimum allowed width in pixels.

Type undefined | false | true

Default false

Inherited from IAxisRendererSettings

Re-enable display of skipped grid lines due to lack of space and as per the minGridDistance setting. Not recommended for CategoryAxis with a lot of data items.

Click here for more info
@since 5.6.0

Type undefined | false | true

Default false

Inherited from IAxisRendererSettings

Enable labels on minor grid. If you enable labels, grid will be enabled automatically.

Click here for more info
@since 5.6.0

Type undefined | false | true

Default false


Inherited from IGraphicsSettings

Indicates if stroke of a Graphics should stay the same when it's scale changes. Note, this doesn't take into account parent container scale changes.

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 "none" | "zoom"

Default "none"


Inherited from IAxisRendererSettings

If set to "zoom" will enable axis zoom by panning it in the axis label area.

Works on AxisRendererX and AxisRendererY only.

For a better result, set maxDeviation to 1 or so on the Axis.

Will not work if inside is set to true.

@since 5.0.7

Type undefined | number

Default 1


Inherited from IAxisRendererSettings

Sensitivity of panning. The higher the number, the more sensitive it is.

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

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 IGraphicsSettings

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 IGraphicsSettings

Horizontal shadow offset in pixels.

Click here for more info

Type undefined | number

Inherited from IGraphicsSettings

Vertical shadow offset in pixels.

Click here for more info

Type undefined | number

Inherited from IGraphicsSettings

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 Color

Inherited from IGraphicsSettings

Stroke (border or line) color.

Click here for more information

Type number[] | number

Inherited from IGraphicsSettings

Stroke (border or line) dash settings.

Click here for more information

Type undefined | number

Inherited from IGraphicsSettings

Stroke (border or line) dash offset.

Click here for more information

Type Gradient

Inherited from IGraphicsSettings

Stroke (border or line) gradient.

Click here for more information

Type undefined | number

Inherited from IGraphicsSettings

Opacity of the stroke (border or line). 0 - fully transparent; 1 - fully opaque.

Type Pattern

Inherited from IGraphicsSettings

Stroke (border or line) pattern.

Click here for more information

Type undefined | number

Inherited from IGraphicsSettings

Width of the stroke (border or line) in pixels.

Type undefined | string

Inherited from IGraphicsSettings

Draw a shape using an SVG path.

Click here for more information

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