AxisLabelRadial

Type class

Draws a label on a circular axis.

More info: Axes: labels

Sources

AxisLabelRadial can be used (imported) via one of the following packages.

TypeScript

// Import AxisLabelRadial
import * as am5xy from "@amcharts/amcharts5/xy";

// Create AxisLabelRadial
am5xy.AxisLabelRadial.new(root, {
  // ... config if applicable
});

JavaScript

<!-- Load AxisLabelRadial -->
<script src="xy.js"></script>

<script>
// Create AxisLabelRadial
am5xy.AxisLabelRadial.new(root, {
  // ... config if applicable
});
</script>

Inheritance

AxisLabelRadial extends RadialLabel.

AxisLabelRadial is not extended by any other symbol.

Settings

Set these settings on a AxisLabelRadial object using its set() and setAll() methods. Read about settings concept.

#location

Type undefined | number

Where the label sits within its cell, from 0 (start) to 1 (end). A cell is a category, a date period, or the span of an axis range.

#maxPosition

Type undefined | numberDefault 1

Hides the label when it is closer to the end of the visible part of the axis than this, from 0 to 1: 0.9 hides labels in the last 10%.

#minPosition

Type undefined | numberDefault 0

Hides the label when it is closer to the start of the visible part of the axis than this, from 0 to 1: 0.1 hides labels in the first 10%.

#multiLocation

Type undefined | number

Used instead of location when a grid step spans several units, such as 5 days, or when only every few categories get a label.

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

#baseRadius

Type number | PercentDefault 100%Inherited from IRadialLabelSettings

Where the label sits across the arc it belongs to, such as a slice: a percent, 0% being the inner edge and 100% the outer one, or pixels from the inner edge.

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

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

#inside

Type undefined | false | trueDefault falseInherited from IRadialLabelSettings

Places the label inside the arc instead of outside: radius then counts inward.

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

#kerning

Type undefined | numberDefault 0Inherited from IRadialLabelSettings

Extra spacing between characters in pixels, for "circular" text.

#labelAngle

Type undefined | numberInherited from IRadialLabelSettings

Angle in degrees of the label's position around the center: 0 points right, and angles grow clockwise. Usually set by the series.

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

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

#orientation

Type "inward" | "outward" | "auto"Default "auto"Inherited from IRadialLabelSettings

Which way the text faces with textType "circular": "inward", "outward", or "auto" to pick whichever reads better at its angle.

With "radial", "auto" turns text on the left half so that it does not read upside down.

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

#radius

Type undefined | numberInherited from IRadialLabelSettings

Distance in pixels from baseRadius: outward, or inward when inside is true. A negative value goes the other way.

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

#textType

Type "regular" | "circular" | "radial" | "aligned" | "adjusted"Default "regular"Inherited from IRadialLabelSettings

How the label is placed:

• "regular" - horizontal, at its position on the arc.

• "circular" - curved along the arc.

• "radial" - rotated to run along the radius.

• "aligned" - horizontal, lined up in columns with the other labels.

• "adjusted" - horizontal, moved outward so that its edge, not its center, is at its position.

IMPORTANT! In a PieSeries, alignLabels (true by default) overrides textType. To use a type other than "aligned", also set alignLabels: false on the series.

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

Private settings

These are read-only settings accessible from a AxisLabelRadial object using its getPrivate() method. Read about private settings.

7 inherited items

#focusable

Read onlyType undefined | false | trueInherited from ISpritePrivateSince 5.3.16

If set to false, its tabindex will be set to -1, so it does not get focused with TAB, regardless whether its public setting focusable is set to true.

#htmlElement

Read onlyType HTMLDivElementInherited from IContainerPrivate

The <div> element that holds the container's html content.

#htmlElementWrapper

Read onlyType HTMLDivElementInherited from IContainerPrivateSince 5.11.2

A wrapper <div> for htmlElement.

#lastTooltipCoords

Read onlyType IPointInherited from ISpritePrivateSince 5.11.3

The last point the tooltip was shown at, so it is not shown again at the same place.

#showingTooltip

Read onlyType undefined | false | trueInherited from ISpritePrivate

true while the element shows its tooltip.

#tooltipTarget

Read onlyType GraphicsInherited from ISpritePrivate

An element whose tooltip point and colors the tooltip uses, in place of this element's.

#trustBounds

Read onlyType undefined | false | trueInherited from ISpritePrivateSince 5.5.0

Checks that the pointer is within the element's bounds before dispatching "pointerover". This prevents ghost tooltips that sometimes appear while the pointer moves over interactive elements.

It is true by default on Rectangle and Circle.

Properties

#className

StaticType stringDefault "AxisLabelRadial"

#classNames

StaticType ArrayDefault RadialLabel.classNames.concat([AxisLabelRadial.className])

11 inherited items

#adapters

Type AdaptersDefault new Adapters(this)Inherited from Entity

#children

Type ChildrenDefault new Children(this)Inherited from Container

The container's child elements.

#dataItem

Type DataItem | undefinedInherited from Sprite

The element's DataItem, or, if it has none, its nearest parent's.

NOTE: data items are assigned automatically in most cases where it matters. Set one only if you know what you are doing.

#enableDispose

Type booleanDefault trueInherited from Settings

Set to false to make dispose() do nothing.

#events

Type SpriteEventDispatcherInherited from Sprite

#parent

Type Container | undefinedInherited from Sprite

Parent Container of this element.

#root

Type RootInherited from EntitySince 5.0.6

The Root the object belongs to.

#states

Type StatesDefault new States(this)Inherited from Entity

#template

Type Template | undefinedInherited from Entity

A Template applied to the object. Its settings apply where the object has none set of its own.

#uid

Type numberDefault ++counterInherited from Settings

A unique number, given to each object as it is created.

#virtualParent

Type Container | undefinedInherited from Sprite

Methods

67 inherited items

#allChildren()

Returns ArrayInherited from Container

Returns all children, including the background, vertical scrollbar and mask.

#animate(options: AnimationOptions)

Returns AnimationInherited from Settings

Animates a setting from its current value (or from) to to. The setting jumps to from at once. With duration 0, or no value to start from, it is set to to at once and the returned animation is already stopped.

More info: Animations: animating settings

#appear(duration?: undefined | number,
delay?: undefined | number)

Returns PromiseInherited from Sprite

Plays the reveal animation: hides the element at once, then shows it, whether it was hidden or not.

#baseRadius()

Returns numberInherited from RadialLabel

Returns the radius in pixels that baseRadius points to.

#compositeOpacity()

Returns numberInherited from SpriteSince 5.2.11

Returns the element's opacity multiplied by those of all its parents.

#compositeRotation()

Returns numberInherited from SpriteSince 5.9.2

Returns the element's rotation plus those of all its parents, in degrees.

#compositeScale()

Returns numberInherited from SpriteSince 5.9.2

Returns the element's scale multiplied by those of all its parents.

#contentHeight()

Returns numberInherited from Container

#contentWidth()

Returns numberInherited from Container

#depth()

Returns numberInherited from Sprite

Returns how deep the element is in the tree: the number of parents it has.

#dispose()

Returns voidInherited from Settings

Disposes the object, freeing everything it holds. A disposed object can't be used again.

#eachChildren(f: (child: Sprite) => void)

Returns voidInherited from Container

Calls f for each child, including the background, vertical scrollbar and mask.

#get(key: Key,
fallback: F)

Returns NonNullable | FInherited from Entity

Returns the value of setting key, run through any adapters, or fallback if it is not set.

More info: Settings

#getAccessibleText()

Returns stringInherited from Label

Returns "aria-label" text with populated placeholders and formatting if populateText is set to true.

#getDateFormatter()

Returns DateFormatterInherited from Sprite

Returns the DateFormatter of the element: its own dateFormatter, or else the one of the Root.

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

#getDurationFormatter()

Returns DurationFormatterInherited from Sprite

Returns the DurationFormatter of the element: its own durationFormatter, or else the one of the Root.

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

#getNumberFormatter()

Returns NumberFormatterInherited from Sprite

Returns the NumberFormatter of the element: its own numberFormatter, or else the one of the Root.

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

#getText()

Returns stringInherited from Label

Returns the label's text, with data placeholders filled in when populateText is true.

#getTooltip()

Returns Tooltip | undefinedInherited from Sprite

Returns the element's Tooltip: its own tooltip, or else the nearest parent's.

#has(key: Key)

Returns booleanInherited from Settings

Returns true if setting key is set.

More info: Settings

#height()

Returns numberInherited from Sprite

Returns the element's height in pixels.

#hide(duration?: undefined | number)

Returns PromiseInherited from Sprite

Hides the element and returns a Promise that resolves when its hiding animations finish.

series.hide().then(function(ev) {
  console.log("Series finished hiding");
})

series.hide().then(function(ev) {
  console.log("Series finished hiding");
})

#hideTooltip()

Returns Promise | undefinedInherited from Sprite

Hides the element's Tooltip.

#hover()

Returns voidInherited from Sprite

Hovers the element as if the pointer were over it: applies its hover state and shows its tooltip.

#innerHeight()

Returns numberInherited from Container

Returns the container's height without padding, in pixels.

#innerWidth()

Returns numberInherited from Container

Returns the container's width without padding, in pixels.

#isDisposed()

Returns booleanInherited from Settings

Returns true if the object has been disposed.

#isDragging()

Returns booleanInherited from Sprite

Returns true while the element is being dragged.

#isFocus()

Returns booleanInherited from Sprite

Returns true if this element does currently have focus.

#isHidden()

Returns booleanInherited from Sprite

Returns true if the element was hidden with hide(), even while its hiding animation still plays. For the visible setting, use isVisible().

#isHiding()

Returns booleanInherited from Sprite

Returns true while the element's hiding animation plays.

#isHover()

Returns booleanInherited from Sprite

Returns true if the pointer is over the element.

#isShowing()

Returns booleanInherited from Sprite

Returns true while the element's showing animation plays.

#isType(type: string)

Returns thisInherited from Entity

Returns true if the object is of class type or extends it.

#isVisible()

Returns booleanInherited from Sprite

Returns false if either the public or the private setting visible is false, or forceHidden is true.

#isVisibleDeep()

Returns booleanInherited from SpriteSince 5.2.7

Same as isVisible(), except it checks all ascendants, too.

#markDirtyKey(key: Key)

Returns voidInherited from Sprite

Marks a setting as changed, so the element reads it again, running its adapters, on the next frame.

#maxHeight()

Returns numberInherited from Sprite

Returns the most height the element may take, in pixels: its maxHeight, a fixed height, or else its parent's inner height.

#maxWidth()

Returns numberInherited from Sprite

Returns the most width the element may take, in pixels: its maxWidth, a fixed width, or else its parent's inner width.

#new(root: Root,
settings: ITSettings,
template?: Template)

StaticReturns TInherited from Entity

Creates an instance of the class. Use it instead of new Class().

More info: Getting started: new element syntax

#off(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with on(). Without callback, removes all of them for key.

More info: Events: settings value change

#offDebounced(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

#offDebouncedPrivate(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onPrivateDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

#offPrivate(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with onPrivate(). Without callback, removes all of them for key.

More info: Events: settings value change

#on(key: Key,
callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from Settings

Calls callback each time the value of setting key changes or is removed. Setting the same value again does not call it.

More info: Events: settings value change

#once(key: Key,
callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from SettingsSince 5.20.4

Like on(), but the callback is removed after it is called once.

More info: Events: settings value change

#onceDebounced(key: Key,
callback: (value: [""], target: this, key: Key) => void,
debounceDelay: number)

Returns IDisposerInherited from SettingsSince 5.20.4

Like onDebounced(), but the callback is removed after it is called once.

More info: Events: settings value change

#onDebounced(key: Key,
callback: (value: [""], target: this, key: Key) => void,
debounceDelay: number)

Returns IDisposerInherited from Settings

Like on(), but waits until setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

#onPrivate(key: Key,
callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from Settings

Calls callback each time the value of private setting key changes.

More info: Events: settings value change

#onPrivateDebounced(key: Key,
callback: (value: [""], target: this, key: Key) => void,
debounceDelay: number)

Returns IDisposerInherited from Settings

Like onPrivate(), but waits until private setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

#radius()

Returns numberInherited from RadialLabel

Returns the label's radius in pixels: the base radius plus the radius adjustment.

#remove(key: Key)

Returns voidInherited from Entity

Removes the value set for setting key. The setting goes back to the value from a theme or template, if one has it.

More info: Settings

#removeAll()

Returns voidInherited from Settings

Removes all settings, as remove() does for each one.

More info: Settings

#scrollToChild(child: Sprite)

Returns voidInherited from ContainerSince 5.10.5

Scrolls the container so that the child comes into view, if it is out of view. Works only on a container with a verticalScrollbar.

#set(key: Key,
value: Value)

Returns ValueInherited from Entity

Sets setting key to value and returns value. A value set this way overrides themes and templates, and stops any animation of the setting.

More info: Settings

#setAll(settings: Partial)

Returns voidInherited from Settings

Sets several settings at once, from an object of key-value pairs.

More info: Settings

#setTimeout(fn: () => void,
delay: number)

Returns IDisposerInherited from Entity

Calls fn after delay milliseconds, unless the object is disposed first. Disposing the returned disposer cancels it.

#show(duration?: undefined | number)

Returns PromiseInherited from Sprite

Shows the element and returns a Promise that resolves when its showing animations finish.

series.show().then(function(ev) {
  console.log("Series is now fully visible");
})

series.show().then(function(ev) {
  console.log("Series is now fully visible");
})

#showTooltip(point?: IPoint)

Returns Promise | undefinedInherited from Sprite

Shows the element's Tooltip. Does nothing if the element has no tooltipText or tooltipHTML.

#toBack()

Returns voidInherited from Sprite

Moves the element to the start of its parent's children, so it is drawn under its siblings, or, in a layout, placed first.

#toFront()

Returns voidInherited from Sprite

Moves the element to the end of its parent's children, so it is drawn over its siblings, or, in a layout, placed last.

#toGlobal(point: IPoint)

Returns IPointInherited from Sprite

Converts a point within the element to a point relative to the root.

#toLocal(point: IPoint)

Returns IPointInherited from Sprite

Converts a point relative to the root to a point within the element.

#unhover()

Returns voidInherited from Sprite

Ends a hover, as if the pointer left the element: hides its tooltip and takes it out of its hover state.

#width()

Returns numberInherited from Sprite

Returns the element's width in pixels.

#x()

Returns numberInherited from Sprite

Returns the element's X position in pixels, relative to its parent, without dx.

#y()

Returns numberInherited from Sprite

Returns the element's Y position in pixels, relative to its parent, without dy.

Events

Add event handlers to AxisLabelRadial object using its events.on() method. Read about adding event handlers.

20 inherited items

#blur

Param { type: "blur", target: AxisLabelRadial, originalEvent: FocusEvent, target: Sprite }Inherited from ISpriteEvents

Invoked when element loses focus.

#boundschanged

Param { type: "boundschanged", target: AxisLabelRadial }Inherited from ISpriteEvents

The element's bounds changed.

#click

Param { type: "click", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

The element was clicked or tapped. A press and release more than 5 pixels apart is not a click.

#dataitemchanged

Param { type: "dataitemchanged", target: AxisLabelRadial, newDataItem: DataItem | undefined, oldDataItem: DataItem | undefined }Inherited from ISpriteEvents

The element's data item changed.

#dblclick

Param { type: "dblclick", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

The element was double-clicked or double-tapped. Also dispatched on its parents.

#dragged

Param { type: "dragged", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

The element moved while being dragged.

#dragstart

Param { type: "dragstart", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

Dragging of the element started: the pointer moved more than 5 pixels after pressing on it.

#dragstop

Param { type: "dragstop", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

Dragging of the element stopped.

#focus

Param { type: "focus", target: AxisLabelRadial, originalEvent: FocusEvent, target: Sprite }Inherited from ISpriteEvents

Invoked when element gains focus.

#globalpointerdown

Param { type: "globalpointerdown", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

A pointer button was pressed, or a touch started, anywhere in the window, even outside the chart.

#globalpointermove

Param { type: "globalpointermove", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

The pointer moved anywhere in the window, even outside the chart.

#globalpointerup

Param { type: "globalpointerup", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

A pointer button was released, or a touch ended, anywhere in the window, even outside the chart.

#middleclick

Param { type: "middleclick", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

The element was clicked with the middle mouse button.

#pointerdown

Param { type: "pointerdown", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

A pointer button was pressed, or a touch started, over the element. Also dispatched on its parents.

#pointerout

Param { type: "pointerout", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

The pointer left the element.

#pointerover

Param { type: "pointerover", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

The pointer moved over the element.

#pointerup

Param { type: "pointerup", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

A pointer button was released, or a touch ended, over the element.

#positionchanged

Param { type: "positionchanged", target: AxisLabelRadial }Inherited from ISpriteEvents

The element's position changed.

#rightclick

Param { type: "rightclick", target: AxisLabelRadial } & ISpritePointerEventInherited from ISpriteEvents

The element was clicked with the right mouse button.

#wheel

Param { type: "wheel", target: AxisLabelRadial, originalEvent: WheelEvent, point: IPoint }Inherited from ISpriteEvents

The mouse wheel turned while the pointer was over the element. Also dispatched on its parents.