IEditableAxisLabelSettings

Type interface

Sources

IEditableAxisLabelSettings is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IEditableAxisLabelSettings extends IEditableLabelSettings.

IEditableAxisLabelSettings is not extended by any other symbol.

Properties

126 inherited items

#active

Type undefined | false | trueInherited from ISpriteSettings

Applies the element's "active" state while true.

#animations

Type ArrayInherited from IEntitySettingsSince 5.20.8

Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it.

Each one animates a setting of the element (or, with target: "dataItem", a value of its data item - a map point's positionOnLine, say). They start when the setting is applied, restart when it changes, and stop when the element is disposed. A saved config keeps what was configured, never a value caught half way through an animation.

sprite.set("animations", [
  { key: "rotation", to: 360, duration: 4000, loops: 0 },
  { key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" }
]);

#appearDelay

Type undefined | numberDefault 0Inherited from ISpriteSettingsSince 5.21.0

Milliseconds to wait before the autoAppear animation starts. The element stays hidden until then.

#appearDuration

Type undefined | numberInherited from ISpriteSettingsSince 5.21.0

Duration of the autoAppear animation, in milliseconds. Without it, the element's stateAnimationDuration is used.

#ariaChecked

Type undefined | false | trueInherited from ISpriteSettings

aria-checked setting.

This setting is ignored unless role is one of the following:

• "checkbox"

• "option"

• "radio"

• "menuitemcheckbox"

• "menuitemradio"

• "treeitem" On a toggle "button" (one with toggleKey) it is exposed as aria-pressed.

#ariaControls

Type undefined | stringInherited from ISpriteSettings

aria-controls setting.

#ariaCurrent

Type undefined | stringInherited from ISpriteSettingsSince 5.9.8

aria-current setting.

More info: https://w3c.github.io/aria/#aria-current

#ariaExpanded

Type undefined | false | trueInherited from ISpriteSettingsSince 5.21.0

aria-expanded setting: whether the content the element shows or hides (e.g. a task's subtasks, a node's children) is shown.

More info: https://w3c.github.io/aria/#aria-expanded

#ariaHidden

Type undefined | false | trueInherited from ISpriteSettings

aria-hidden setting.

#ariaLabel

Type undefined | stringInherited from ISpriteSettings

Label for the element to use for screen readers.

More info: Accessibility: screen reader

#ariaLive

Type AriaLiveInherited from ISpriteSettings

aria-live setting.

#ariaOrientation

Type undefined | stringInherited from ISpriteSettings

aria-orientation setting.

#ariaSelected

Type undefined | false | trueInherited from ISpriteSettingsSince 5.9.8

aria-selected setting.

More info: https://w3c.github.io/aria/#aria-selected

#ariaValueMax

Type undefined | stringInherited from ISpriteSettings

aria-valuemax setting.

#ariaValueMin

Type undefined | stringInherited from ISpriteSettings

aria-valuemin setting.

#ariaValueNow

Type undefined | stringInherited from ISpriteSettings

aria-valuenow setting.

#ariaValueText

Type undefined | stringInherited from ISpriteSettings

aria-valuetext setting.

#autoAppear

Type undefined | false | trueDefault falseInherited from ISpriteSettingsSince 5.21.0

Plays the element's reveal animation, as appear() does, when it is first drawn: a chart fades in, a series grows its columns or lines from the base. A series waits for its first data. It plays once: data updates do not replay it, but turning the setting off and on again does.

Elements made from a template play as each one is made.

An element that starts hidden (visible: false, or hidden in code before it is drawn) stays hidden. An animations entry on the same setting, such as a pulsing opacity, keeps playing.

This is how a JSON config gets the opening animation, as a config cannot call appear().

chart.setAll({ autoAppear: true, appearDuration: 1000, appearDelay: 100 });
series.setAll({ autoAppear: true, appearDuration: 1000 });

chart.setAll({ autoAppear: true, appearDuration: 1000, appearDelay: 100 });
series.setAll({ autoAppear: true, appearDuration: 1000 });

More info: Animations

#background

Type GraphicsInherited from IContainerSettings

Element drawn behind the container's content, sized to fill the container.

More info: Containers: background

#baselineRatio

Type undefined | numberDefault 0.19Inherited from ILabelSettings

Share of the line height that lies below the text's baseline.

#blur

Type undefined | numberInherited from ISpriteSettingsSince 5.5.0

Blur radius in pixels, from 0 (no blur) up.

IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

#breakWords

Type undefined | false | trueDefault falseInherited from ILabelSettings

Lets truncation cut words in the middle. Wrapping does not use it.

#brightness

Type undefined | numberInherited from ISpriteSettingsSince 5.5.0

Brightness.

• 0 - completely black

• 1 - no changes (default)

• >1 - brighter IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

#centerX

Type number | PercentInherited from ISpriteSettings

The point of the element that is placed at its x position, and that it rotates and scales around: pixels from its left edge, or a percent of its width.

#centerY

Type number | PercentInherited from ISpriteSettings

The point of the element that is placed at its y position, and that it rotates and scales around: pixels from its top edge, or a percent of its height.

#clickAnnounceText

Type undefined | stringInherited from ISpriteSettingsSince 5.10.8

If set, the text will be read out (announced) by a screen reader when focused element is "clicked" (by pressing ENTER or SPACE).

#contrast

Type undefined | numberInherited from ISpriteSettingsSince 5.5.0

Contrast.

• 0 - completely gray

• 1 - no changes (default)

• >1 - more contrast IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

#crisp

Type undefined | false | trueDefault falseInherited from ISpriteSettingsSince 5.3.0

Draws the element sharply, with minimal anti-aliasing: its position is rounded to whole pixels, and strokeWidth is adjusted to the device pixel ratio, so lines may look thinner than expected.

NOTE: it may not work well on several elements that are meant to fit together exactly.

#cursorOverStyle

Type undefined | stringInherited from ISpriteSettings

CSS cursor to show while the pointer is over the element, e.g.

"pointer".

More info: https://developer.mozilla.org/en-US/docs/Web/CSS/cursor

#dateFormatter

Type DateFormatter | undefinedInherited from ISpriteSettings

A DateFormatter to use for this element instead of the root's.

More info: /v5/concepts/using-formatters/

#direction

Type "ltr" | "rtl"Default "ltr"Inherited from ILabelSettings

Text direction.

#disabled

Type undefined | false | trueInherited from ISpriteSettings

Applies the element's "disabled" state while true. It changes only the look: the element still responds to the pointer.

#draggable

Type undefined | false | trueInherited from ISpriteSettings

Lets the user drag the element. Touches that start on it no longer scroll the page.

#durationFormatter

Type DurationFormatter | undefinedInherited from ISpriteSettings

A DurationFormatter to use for this element instead of the root's.

More info: /v5/concepts/using-formatters/

#dx

Type undefined | numberInherited from ISpriteSettings

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

#dy

Type undefined | numberInherited from ISpriteSettings

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

#editOn

Type "click" | "dblclick" | "rightclick" | "middleclick" | "none"Default "click"Inherited from IEditableLabelSettings

Which click starts editing: "click", "dblclick", "rightclick" or "middleclick". With "none", only setting active to true does.

#ellipsis

Type undefined | stringDefault "…"Inherited from ILabelSettings

Characters added at the end of truncated text.

The default Unicode ellipsis ("…") is missing from some fonts. If it looks broken, use other characters, e.g.:

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

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

#exportable

Type undefined | false | trueInherited from ISpriteSettings

If false, the element is left out of exported images of the chart.

#fill

Type ColorInherited from ILabelSettings

Text color.

#fillGradient

Type GradientInherited from ILabelSettingsSince 5.10.1

Fill gradient.

More info: Gradientsrmation

#fillOpacity

Type undefined | numberDefault 1Inherited from ILabelSettingsSince 5.2.39

Text opacity, from 0 (transparent) to 1 (opaque).

#focusable

Type undefined | false | trueInherited from ISpriteSettings

Can element be focused, i.e. selected using TAB key.

More info: Accessibility: focusing elements

#focusableGroup

Type string | numberInherited from ISpriteSettingsSince 5.0.6

An identifier by which to group common elements into focusable groups.

If set, only the first element in he group will be focusable via TAB key.

When it is selected, the rest of the elements in the same group can be selected using arrow keys.

It allows users to TAB-through chart elements quickly without the need to TAB into each and every element.

It's up to implementer of the charts to provide meaningful ariaLabel to the element, which advertises this capability and provides adequate instructions.

More info: Accessibility: grouping focusable elements

#fontFamily

Type undefined | stringInherited from ILabelSettings

Font family, or a comma-separated list of them.

"inherit" uses the font of the chart's container element (since 5.17.3).

#fontSize

Type string | numberInherited from ILabelSettings

Font size: a number in pixels, or any CSS size, such as "1em" or "12pt".

#fontStyle

Type "normal" | "italic" | "oblique"Inherited from ILabelSettings

Font style.

#fontVariant

Type "normal" | "small-caps"Inherited from ILabelSettings

Font variant.

#fontWeight

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

Font weight.

#forceHidden

Type undefined | false | trueInherited from ISpriteSettings

Hides the element whatever its visible setting, even when show() is called.

#forceInactive

Type undefined | false | trueInherited from ISpriteSettingsSince 5.0.21

Makes the element and its children ignore the pointer, even with interactive: true or event listeners set.

#height

Type number | Percent | nullInherited from ISpriteSettings

Height in pixels, or a Percent of the parent's inner height. In a vertical layout, a percent height is a share of the height the other children leave.

#hoverOnFocus

Type undefined | false | trueInherited from ISpriteSettings

Simulate hover on an element when it gains focus, including changing hover appearance and displaying a tooltip if applicable.

More info: Accessibility: focusing elements

#html

Type undefined | stringInherited from IContainerSettingsSince 5.2.11

HTML content of the container. It can hold data placeholders, such as {category}.

More info: HTML content

#hue

Type undefined | numberInherited from ISpriteSettingsSince 5.5.0

Rotates the hue of all colors by this many degrees, from 0 to 360.

IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

#id

Type undefined | stringInherited from IEntitySettings

A unique ID for looking the element up in root.entitiesById. Setting an ID that another element already has throws an error.

#ignoreFormatting

Type undefined | false | trueDefault falseInherited from ILabelSettings

Shows text exactly as it is, without applying in-line formatting blocks such as [bold].

#ignoreThemes

Type undefined | false | trueDefault falseInherited from IEntitySettingsSince 5.15.6

Ignores themes: no theme rule applies to the element, not even one of the default theme.

#interactive

Type undefined | false | trueInherited from ISpriteSettings

Makes the element respond to the pointer. Adding a pointer event listener to it turns this on.

#interactiveChildren

Type undefined | false | trueDefault trueInherited from IContainerSettings

Makes every descendant, not just direct children, interactive when the container itself is interactive.

#invert

Type undefined | numberInherited from ISpriteSettingsSince 5.5.0

Color inversion, from 0 (no changes) to 1 (fully inverted colors).

IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

#isMeasured

Type undefined | false | trueDefault trueInherited from ISpriteSettings

If false, the element's bounds are not measured, so it takes no part in its parent's layout or size.

#layer

Type undefined | numberInherited from ISpriteSettings

Layer to draw the element on: elements on higher layers show in front of those on lower ones. If not set, the element is on its parent's layer.

#layerMargin

Type IMarginInherited from ISpriteSettingsSince @5.2.39

Margins in pixels that make the element's layer larger than the chart, or, when negative, smaller.

#layout

Type Layout | nullInherited from IContainerSettings

How children are arranged, e.g. root.horizontalLayout, root.verticalLayout or root.gridLayout. Without a layout, children are placed by their own x and y.

More info: Containers: layout

#lineHeight

Type Percent | numberInherited from ILabelSettings

Line height as a multiple of the font's line height: a number, such as 1.5, or a percent, such as am5.percent(150). If not set, it is 1.2.

#marginBottom

Type undefined | numberInherited from ISpriteSettings

Bottom margin in pixels.

#marginLeft

Type undefined | numberInherited from ISpriteSettings

Left margin in pixels.

#marginRight

Type undefined | numberInherited from ISpriteSettings

Right margin in pixels.

#marginTop

Type undefined | numberInherited from ISpriteSettings

Top margin in pixels.

#mask

Type Graphics | nullInherited from IContainerSettings

An element whose shape clips the container's children.

More info: Containers: masks

#maskContent

Type undefined | false | trueInherited from IContainerSettings

Clips all content that goes outside the container's bounds.

#maxChars

Type undefined | numberInherited from ILabelSettingsSince 5.7.2

Maximum number of characters in the label. A longer text is cut, using the breakWords and ellipsis settings.

#maxHeight

Type number | nullInherited from ISpriteSettings

Maximum allowed height in pixels.

#maxWidth

Type number | nullInherited from ISpriteSettings

Maximum allowed width in pixels.

#minHeight

Type number | nullInherited from ISpriteSettings

Minimum allowed height in pixels.

#minScale

Type undefined | numberInherited from ILabelSettings

Smallest scale, from 0 to 1, that oversizedBehavior: "fit" may shrink the text to. Text that would need to shrink more is hidden.

#minWidth

Type number | nullInherited from ISpriteSettings

Minimum allowed width in pixels.

#multiLine

Type undefined | false | trueDefault trueInherited from IEditableLabelSettingsSince 5.9.6

Allows line breaks in the text. With false, ENTER finishes editing.

#numberFormatter

Type NumberFormatter | undefinedInherited from ISpriteSettings

A NumberFormatter to use for this element instead of the root's.

More info: /v5/concepts/using-formatters/

#opacity

Type undefined | numberInherited from ILabelSettings

Opacity of the label, from 0 (transparent) to 1 (opaque).

#oversizedBehavior

Type "none" | "hide" | "fit" | "wrap" | "wrap-no-break" | "truncate"Inherited from ILabelSettings

What to do with text that does not fit the label's maxWidth (or maxHeight): "hide" it, "fit" it by scaling it down, "wrap" it onto more lines, wrap it without breaking words ("wrap-no-break"), or "truncate" it with an ellipsis.

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

More info: Labels: oversized text

#paddingBottom

Type undefined | numberInherited from IContainerSettings

Bottom padding in pixels.

#paddingLeft

Type undefined | numberInherited from IContainerSettings

Left padding in pixels.

#paddingRight

Type undefined | numberInherited from IContainerSettings

Right padding in pixels.

#paddingTop

Type undefined | numberInherited from IContainerSettings

Top padding in pixels.

#populateText

Type undefined | false | trueDefault falseInherited from ILabelSettings

Fills data placeholders in text, such as {value}, with values from the label's data item.

More info: Labels: data placeholders

#position

Type "absolute" | "relative"Default "relative"Inherited from ISpriteSettings

Positioning of the element.

"absolute" leaves the element out of its parent's layout and size: it is placed by its x and y only.

#reverseChildren

Type undefined | false | trueInherited from IContainerSettingsSince 5.1.1

Lays out the children in reverse order.

#role

Type RoleInherited from ISpriteSettings

Element's role.

More info: Accessibility: roles

#rotation

Type undefined | numberDefault 0Inherited from ISpriteSettings

Rotation in degrees, clockwise, around the point set by centerX and centerY.

#saturate

Type undefined | numberInherited from ISpriteSettingsSince 5.5.0

Saturation.

• 0 - grayscale

• 1 - no changes (default)

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

More info: Filters

#scale

Type undefined | numberDefault 1Inherited from ISpriteSettings

Scale, around the point set by centerX and centerY: below 1 shrinks the element, above 1 enlarges it.

#sepia

Type undefined | numberInherited from ISpriteSettingsSince 5.5.0

Sepia tone, from 0 (no changes) to 1 (full sepia).

IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

#setStateOnChildren

Type undefined | false | trueDefault falseInherited from IContainerSettings

Applies every state set on the container to its children too.

More info: Containers: states

#shadowBlur

Type undefined | numberInherited from ILabelSettings

Blurriness of the shadow: the bigger the number, the blurrier the shadow.

More info: Shadows

#shadowColor

Type Color | nullInherited from ILabelSettings

Color of the text's shadow. It shows only when shadowBlur, shadowOffsetX or shadowOffsetY is set too.

More info: Shadows

#shadowOffsetX

Type undefined | numberInherited from ILabelSettings

Horizontal shadow offset in pixels.

More info: Shadows

#shadowOffsetY

Type undefined | numberInherited from ILabelSettings

Vertical shadow offset in pixels.

More info: Shadows

#shadowOpacity

Type undefined | numberInherited from ILabelSettings

Opacity of the shadow, from 0 to 1. If not set, the shadow takes the opacity of the text.

More info: Shadows

#showTooltipOn

Type "hover" | "always" | "click"Default "hover"Inherited from ISpriteSettingsSince 5.0.16

When the element's tooltip shows:

• "hover" (default) - while the pointer is over the element, or after a tap on it until a tap elsewhere.

• "always" - all the time. To show tooltips of several elements at once, give each its own Tooltip (tooltip).

• "click" - after a click or tap on the element, until a click anywhere else on the page.

More info: Tooltips: sticky tooltips

#stateAnimationDuration

Type undefined | numberDefault 0Inherited from IEntitySettings

How long, in milliseconds, a switch from one state to another animates.

0 switches at once.

#stateAnimationEasing

Type $ease.EasingDefault out(cubic)Inherited from IEntitySettings

Easing of the animated switch from one state to another.

#tabindexOrder

Type undefined | numberInherited from ISpriteSettings

An internal order by which focusable elements will be selected within the chart.

More info: Accessibility: focusing elements

#templateField

Type undefined | stringInherited from ISpriteSettings

Field in the data item's data object that holds settings for this element, applied over its template's.

More info: Template fields

#text

Type undefined | stringInherited from ILabelSettings

The label's text. It can hold in-line formatting and, with populateText, data placeholders.

More info: Text styling for text styling info

#textAlign

Type "start" | "end" | "left" | "right" | "center"Inherited from ILabelSettings

Horizontal alignment of the text's lines.

#textBaseline

Type "top" | "hanging" | "middle" | "alphabetic" | "ideographic" | "bottom"Inherited from ILabelSettings

The baseline the text is aligned to vertically, as in the canvas textBaseline.

#textDecoration

Type "underline" | "line-through"Inherited from ILabelSettingsSince 5.0.15

Text decoration: "underline" or "line-through".

#themes

Type ArrayInherited from IEntitySettings

Themes applied to the element and everything inside it.

#themeTags

Type ArrayInherited from IEntitySettings

Tags that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent.

More info: Themes

#themeTagsSelf

Type ArrayInherited from IEntitySettings

Tags that theme rules can target, like themeTags, but only for this element, not its children.

More info: Themes

#toggleKey

Type "disabled" | "active" | "none" | undefinedInherited from ISpriteSettings

Setting that a click or tap toggles between true and false:

"active" or "disabled". "none" turns toggling off.

#tooltip

Type TooltipInherited from ISpriteSettings

The Tooltip to show for the element. If not set, the nearest parent's is used.

#tooltipHTML

Type undefined | stringInherited from ISpriteSettingsSince 5.2.11

HTML content of the element's tooltip, shown in place of tooltipText.

#tooltipPosition

Type "fixed" | "pointer"Default "fixed"Inherited from ISpriteSettings

Where the tooltip points: "fixed" at tooltipX and tooltipY, or "pointer" at the pointer, following it.

#tooltipText

Type undefined | stringInherited from ISpriteSettings

Text of the element's tooltip. It can hold data placeholders, such as {value}.

#tooltipX

Type number | PercentDefault am5.percent(50)Inherited from ISpriteSettings

Where on the element the tooltip points, horizontally: pixels from its left edge, or a percent of its width.

#tooltipY

Type number | PercentDefault am5.percent(50)Inherited from ISpriteSettings

Where on the element the tooltip points, vertically: pixels from its top edge, or a percent of its height.

#userData

Type anyInherited from IEntitySettings

Any data of your own to keep with the element.

#verticalScrollbar

Type ScrollbarInherited from IContainerSettings

A Scrollbar that scrolls the content vertically when it does not fit in the container.

More info: Containers: scrollbar

#visible

Type undefined | false | trueDefault trueInherited from ISpriteSettings

Whether the element is shown. Unlike show() and hide(), it does not animate.

#wheelable

Type undefined | false | trueInherited from ISpriteSettings

Makes the element receive mouse wheel events. While the pointer is over it, the wheel no longer scrolls the page.

#width

Type number | Percent | nullInherited from ISpriteSettings

Width in pixels, or a Percent of the parent's inner width. In a horizontal layout, a percent width is a share of the width the other children leave.

#x

Type number | Percent | nullInherited from ISpriteSettings

X position in the parent: pixels from its left edge, or a Percent of its inner width, measured from inside its left padding.

#y

Type number | Percent | nullInherited from ISpriteSettings

Y position in the parent: pixels from its top edge, or a Percent of its inner height, measured from inside its top padding.