ILabelSeriesSettings

Type interface

Sources

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

Inheritance

ILabelSeriesSettings extends IPolylineSeriesSettings.

ILabelSeriesSettings is extended by ICalloutSeriesSettings.

Properties

#labelFill

Type Color

Text color of new labels and, when changed, of the selected ones.

#labelFontFamily

Type undefined | string

Font family of new labels and, when changed, of the selected ones.

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

#labelFontSize

Type number | string | undefined

Font size of new labels and, when changed, of the selected ones.

#labelFontStyle

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

Font style of new labels and, when changed, of the selected ones.

#labelFontWeight

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

Font weight of new labels and, when changed, of the selected ones.

190 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

#autoGapCount

Type undefined | numberDefault 1.1Inherited from ILineSeriesSettings

With connect set to false and a DateAxis as the base axis, breaks the line where neighboring data items are more than this many base intervals (e.g. days) apart.

More info: Line series: auto gaps with dates

#background

Type GraphicsInherited from IContainerSettings

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

More info: Containers: background

#baseAxis

Type IXYAxisInherited from IXYSeriesSettings

The axis the series runs along, such as the category axis of a column series; the other axis holds its values. If not set, the chart picks the Y axis when it is a category or date axis, and the X axis otherwise.

More info: XY chart series: base axis

#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

#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

#calculateAggregates

Type undefined | false | trueInherited from ISeriesSettings

Makes the series compute aggregate values, such as sums, averages, lows, highs and changes.

Enable it only if they are used, e.g. in tooltips, data fields or heat rules.

#categoryXField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the X category.

More info: XY chart series: data fields

#categoryYField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the Y category.

More info: XY chart series: data fields

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

#connect

Type undefined | false | trueDefault trueInherited from ILineSeriesSettings

Draws the line across data items that have no value. With false, the line breaks there, and also at time gaps longer than autoGapCount.

More info: Line series: gaps

#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

#customValueField

Type undefined | stringInherited from ISeriesSettings

A key to look up in data for an extra numeric value of the data item (customValue), e.g. for heat rules.

#dateFormatter

Type DateFormatter | undefinedInherited from ISpriteSettings

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

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

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

#exactLocationX

Type undefined | false | trueDefault falseInherited from IXYSeriesSettingsSince 5.13.0

Places data points at their exact date on a DateAxis X axis, ignoring locationX. When that axis is the base axis, a column then spans exactly from its open date to its date, so it needs an openValueXField to have any width.

#exactLocationY

Type undefined | false | trueDefault falseInherited from IXYSeriesSettingsSince 5.13.0

Places data points at their exact date on a DateAxis Y axis, ignoring locationY. Columns are not affected.

#excludeFromAggregate

Type ArrayInherited from ISeriesSettingsSince 5.14.4

Fields to leave out of calculateAggregates, to save work where their aggregates are not needed.

#excludeFromTotal

Type undefined | false | trueDefault falseInherited from IXYSeriesSettings

Leaves the series out of the totals (valueYTotal, valueYTotalPercent and the like) that a value axis with calculateTotals works out.

#exportable

Type undefined | false | trueInherited from ISpriteSettings

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

#field

Type "open" | "value" | "low" | "high"Default "value"Inherited from IDrawingSeriesSettings

Value of series that snapping, averages and regressions use: "value" (the close), "open", "low" or "high".

#fill

Type ColorInherited from ISeriesSettings

Series fill color.

More info: XY chart series: series colors

#fillColor

Type ColorInherited from IDrawingSeriesSettings

Fill color of new drawings and, when changed, of the selected ones.

#fillGradient

Type GradientInherited from ISeriesSettings

Series fill gradient.

More info: Gradients

#fillOpacity

Type undefined | numberInherited from IDrawingSeriesSettings

Fill opacity (0 to 1) of new drawings and, when changed, of the selected ones.

#fillPattern

Type PatternInherited from ISeriesSettingsSince 5.10.0

Series fill pattern.

More info: Patterns

#fillShape

Type undefined | false | trueDefault falseInherited from IPolylineSeriesSettingsSince 5.9.0

Closes the shape and fills it, instead of drawing an open line.

#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

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

#groupDataCallback

Type undefined | (dataItem: DataItem, interval: ITimeInterval) => voidInherited from IXYSeriesSettingsSince 5.1.11

Function called for each grouped data item once it is complete, to set values of your own. Its originals hold the source data items.

More info: Date axis: custom aggregation functions

#groupDataDisabled

Type undefined | false | trueInherited from IXYSeriesSettingsSince 5.0.19

Keeps the series' data ungrouped even when its DateAxis has groupData set.

#groupDataWithOriginals

Type undefined | false | trueDefault falseInherited from IXYSeriesSettingsSince 5.1.11

Fills the originals of each grouped data item with the source data items it was made from. Always on when groupDataCallback is set.

#heatRules

Type IHeatRule[]Inherited from ISeriesSettings

Heat rules to apply to the series' elements. A rule without minValue and maxValue needs calculateAggregates to find the value range.

More info: Heat rules

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

#highLocationX

Type undefined | numberDefault 0.5Inherited from IXYSeriesSettings

Horizontal location of the high data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

#highLocationY

Type undefined | numberDefault 0.5Inherited from IXYSeriesSettings

Vertical location of the high data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

#highValueXField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the high X value.

More info: Candlestick and OHLC series

#highValueXGrouped

Type "open" | "close" | "high" | "average" | "sum" | "extreme"Default "high"Inherited from IXYSeriesSettings

How grouping combines the high X values; see valueXGrouped.

#highValueXShow

Type "highValueXWorking" | "highValueXChange" | "highValueXChangePercent" | "highValueXChangeSelection" | "highValueXChangeSelectionPercent" | "highValueXChangePrevious" | "highValueXChangePreviousPercent"Inherited from IXYSeriesSettings

Which form of the high X value the series plots; see valueXShow.

#highValueYField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the high Y value.

More info: Candlestick and OHLC series

#highValueYGrouped

Type "open" | "close" | "high" | "average" | "sum" | "extreme"Default "high"Inherited from IXYSeriesSettings

How grouping combines the high Y values; see valueYGrouped.

#highValueYShow

Type "highValueYWorking" | "highValueYChange" | "highValueYChangePercent" | "highValueYChangeSelection" | "highValueYChangeSelectionPercent" | "highValueYChangePrevious" | "highValueYChangePreviousPercent"Inherited from IXYSeriesSettings

Which form of the high Y value the series plots; see valueYShow.

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

#idField

Type undefined | stringInherited from ISeriesSettings

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

#ignoreMinMax

Type undefined | false | trueDefault falseInherited from IXYSeriesSettings

Leaves the series out when its axes work out their scale.

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

#interpolationDuration

Type undefined | numberDefault 0Inherited from IComponentSettings

Duration in milliseconds of the animation from old values to new ones, e.g. when data changes.

More info: Animations: animating data values

#interpolationEasing

Type $ease.EasingInherited from IComponentSettings

Easing function of the animation from old values to new ones.

More info: Animations: easing functions

#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

#legendDataItem

Type DataItemInherited from ISeriesSettings

The series' data item in a Legend.

#legendLabelText

Type undefined | stringInherited from ISeriesSettings

Text template for the item's label in a Legend.

#legendRangeLabelText

Type undefined | stringInherited from IXYSeriesSettings

Text of the series' legend label while the cursor is not over any of its data items. If not set, legendLabelText is used.

#legendRangeValueText

Type undefined | stringInherited from IXYSeriesSettings

Text of the series' legend value label while the cursor is not over any of its data items.

#legendValueText

Type undefined | stringInherited from ISeriesSettings

Text template for the item's value label in a Legend.

#linkTarget

Type undefined | stringDefault "_self"Inherited from ISeriesSettingsSince 5.20.7

Where a data item's URL opens: "_self" for the same window, "_blank" for a new tab, or a named window / frame. A chart embedded in an iframe usually wants "_blank" or "_top".

#locationX

Type undefined | numberDefault 0.5Inherited from IXYSeriesSettings

Horizontal location of the data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

More info: Line series: data item location

#locationY

Type undefined | numberDefault 0.5Inherited from IXYSeriesSettings

Vertical location of the data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

More info: Line series: data item location

#lowLocationX

Type undefined | numberDefault 0.5Inherited from IXYSeriesSettings

Horizontal location of the low data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

#lowLocationY

Type undefined | numberDefault 0.5Inherited from IXYSeriesSettings

Vertical location of the low data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

#lowValueXField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the low X value.

More info: Candlestick and OHLC series

#lowValueXGrouped

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"Default "low"Inherited from IXYSeriesSettings

How grouping combines the low X values; see valueXGrouped.

#lowValueXShow

Type "lowValueXWorking" | "lowValueXChange" | "lowValueXChangePercent" | "lowValueXChangeSelection" | "lowValueXChangeSelectionPercent" | "lowValueXChangePrevious" | "lowValueXChangePreviousPercent"Inherited from IXYSeriesSettings

Which form of the low X value the series plots; see valueXShow.

#lowValueYField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the low Y value.

More info: Candlestick and OHLC series

#lowValueYGrouped

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"Default "low"Inherited from IXYSeriesSettings

How grouping combines the low Y values; see valueYGrouped.

#lowValueYShow

Type "lowValueYWorking" | "lowValueYChange" | "lowValueYChangePercent" | "lowValueYChangeSelection" | "lowValueYChangeSelectionPercent" | "lowValueYChangePrevious" | "lowValueYChangePreviousPercent"Inherited from IXYSeriesSettings

Which form of the low Y value the series plots; see valueYShow.

#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

#maskBullets

Type undefined | false | trueDefault trueInherited from IXYSeriesSettings

Clips the series' bullets to the plot area.

#maskContent

Type undefined | false | trueInherited from IContainerSettings

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

#maxHeight

Type number | nullInherited from ISpriteSettings

Maximum allowed height in pixels.

#maxWidth

Type number | nullInherited from ISpriteSettings

Maximum allowed width in pixels.

#minBulletDistance

Type undefined | numberInherited from IXYSeriesSettings

Hides the bullets while data items are, on average, closer than this many pixels to each other along the base axis.

More info: XY chart series: bullets

#minDistance

Type undefined | numberDefault 0Inherited from ILineSeriesSettingsSince 5.2.7

Skips points closer than this many pixels to the last point drawn, which simplifies lines with many data points.

#minHeight

Type number | nullInherited from ISpriteSettings

Minimum allowed height in pixels.

#minWidth

Type number | nullInherited from ISpriteSettings

Minimum allowed width in pixels.

#name

Type undefined | stringInherited from ISeriesSettings

Name of the series.

#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 | numberDefault 1Inherited from ISpriteSettings

Opacity, from 0 (transparent) to 1 (opaque).

The theme's "default" state has opacity: 1, so show(), and leaving a state that changes opacity, bring it back to 1, not to a value set here. To come back to another value, set it in the "default" state too:

sprite.states.create("default", { opacity: 0.5 }).

#openCategoryXField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the X category a column starts at, so that it can span several categories.

More info: XY chart series: data fields

#openCategoryYField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the Y category a column starts at, so that it can span several categories.

More info: XY chart series: data fields

#openLocationX

Type undefined | numberInherited from IXYSeriesSettings

Where in its X axis cell the open data point sits: 0 at the start, 0.5 in the middle, 1 at the end. If not set, locationX is used.

#openLocationY

Type undefined | numberInherited from IXYSeriesSettings

Where in its Y axis cell the open data point sits: 0 at the start, 0.5 in the middle, 1 at the end. If not set, locationY is used.

#openValueXField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the open X value, such as where a horizontal column starts.

More info: XY chart series: data fields

#openValueXGrouped

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"Default "open"Inherited from IXYSeriesSettings

How grouping combines the open X values; see valueXGrouped.

More info: Date axis: dynamic data item grouping

#openValueXShow

Type "openValueXWorking" | "openValueXChange" | "openValueXChangePercent" | "openValueXChangeSelection" | "openValueXChangeSelectionPercent" | "openValueXChangePrevious" | "openValueXChangePreviousPercent"Inherited from IXYSeriesSettings

Which form of the open X value the series plots; see valueXShow.

More info: XY chart series: data fields

#openValueYField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the open Y value, such as where a column starts.

More info: XY chart series: data fields

#openValueYGrouped

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"Default "open"Inherited from IXYSeriesSettings

How grouping combines the open Y values; see valueYGrouped.

More info: Date axis: dynamic data item grouping

#openValueYShow

Type "openValueYWorking" | "openValueYChange" | "openValueYChangePercent" | "openValueYChangeSelection" | "openValueYChangeSelectionPercent" | "openValueYChangePrevious" | "openValueYChangePreviousPercent"Inherited from IXYSeriesSettings

Which form of the open Y value the series plots; see valueYShow.

More info: XY chart series: data fields

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

#pointCount

Type undefined | numberInherited from IPolylineSeriesSettingsSince 5.9.0

Number of points after which the shape is finished automatically, as with a triangle.

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

#selectorPadding

Type undefined | numberDefault 10Inherited from IDrawingSeriesSettings

Space in pixels between a selected drawing and its selection rectangle.

#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

#sequencedDelay

Type undefined | numberInherited from ISeriesSettings

Extra delay in milliseconds between the animations of consecutive data items, with sequencedInterpolation.

More info: Animations: animation of series

#sequencedInterpolation

Type undefined | false | trueInherited from ISeriesSettings

Shows and hides the data items one after another instead of all at once, including in the initial animation. Works in XY and percent series.

More info: Animations: animation of series

#series

Type XYSeriesInherited from IDrawingSeriesSettings

The series the drawings snap to with snapToData, usually the main series. The drawing series also finds its StockChart through it.

#seriesTooltipTarget

Type "series" | "bullet"Default "series"Inherited from IXYSeriesSettings

Where the series' tooltip takes its color from: the series (on a column series, the hovered column), or the data item's first bullet.

#setStateOnChildren

Type undefined | false | trueDefault falseInherited from IContainerSettings

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

More info: Containers: states

#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

#snapTooltip

Type undefined | false | trueInherited from IXYSeriesSettings

Lets the cursor show the nearest data item even when there is none in the date interval under the pointer. Works only with a DateAxis.

#stacked

Type undefined | false | trueInherited from IXYSeriesSettings

Stacks the series on the one before it in the chart's series that has the same axes and is of the same type. The first series of a stack doesn't need it set.

Stacking goes by data item index, so all stacked series need the same data items (dates or categories), in the same order.

More info: XY chart series: stacked series

#stackToNegative

Type undefined | false | trueInherited from IXYSeriesSettings

When stacking, puts negative values on the negative values below and positive on positive, so the stack grows away from zero both ways. With false, each value goes on the one right below it, whatever its sign.

More info: XY chart series: negative value stacking

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

#stroke

Type ColorInherited from ISeriesSettings

Series stroke color.

More info: XY chart series: series colors

#strokeColor

Type ColorInherited from IDrawingSeriesSettings

Line color of new drawings and, when changed, of the selected ones.

#strokeDasharray

Type ArrayInherited from IDrawingSeriesSettings

Dash pattern of the lines, such as [4, 2], for new drawings and, when changed, for the selected ones.

#strokeGradient

Type GradientInherited from ISeriesSettings

Series stroke gradient.

More info: Gradients

#strokeOpacity

Type undefined | numberInherited from IDrawingSeriesSettings

Line opacity (0 to 1) of new drawings and, when changed, of the selected ones.

#strokeWidth

Type undefined | numberInherited from IDrawingSeriesSettings

Line width in pixels of new drawings and, when changed, of the selected ones.

#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

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

#tooltipDataItem

Type DataItemInherited from IXYSeriesSettingsSince 5.1.2

The data item the series' tooltip currently shows, such as the one under the cursor.

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

#tooltipPositionX

Type "open" | "value" | "low" | "high"Default "value"Inherited from IXYSeriesSettingsSince 5.0.16

Which of the data item's X values the series' tooltip points at.

#tooltipPositionY

Type "open" | "value" | "low" | "high"Default "value"Inherited from IXYSeriesSettingsSince 5.0.16

Which of the data item's Y values the series' tooltip points at.

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

#urlField

Type undefined | stringInherited from ISeriesSettingsSince 5.20.7

A key to look up in data for a URL to open when the data item's element (a bullet, column, slice, map polygon or map line) is clicked. Links are off until this is set.

#userData

Type anyInherited from IEntitySettings

Any data of your own to keep with the element.

#useSelectionExtremes

Type undefined | false | trueInherited from IXYSeriesSettingsSince 5.10.11

Makes the value axis scale to the series' values within the visible range only, instead of all its values. Useful for stacked series.

#valueField

Type undefined | stringInherited from ISeriesSettings

A key to look up in data for a numeric value of the data item. Some series draw their elements by it; heat rules can use it too.

#valueXField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the X value.

More info: XY chart series: data fields

#valueXGrouped

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"Default "close"Inherited from IXYSeriesSettings

How a DateAxis with groupData combines the X values of the data items it groups into one: "open" takes the first, "close" the last, "extreme" the one farthest from zero, and the rest as named.

More info: Date axis: dynamic data item grouping

#valueXShow

Type "valueXWorking" | "valueXChange" | "valueXChangePercent" | "valueXChangeSelection" | "valueXChangeSelectionPercent" | "valueXChangePrevious" | "valueXChangePreviousPercent" | "valueXTotal" | "valueXTotalPercent" | "valueXSum"Default "valueXWorking"Inherited from IXYSeriesSettings

Which form of the X value the series plots on a ValueAxis: the value itself ("valueXWorking"), or one worked out from it, such as its change since the first visible data item ("valueXChangeSelection") or its percent of the total ("valueXTotalPercent").

More info: XY chart series: data fields

#valueYField

Type undefined | stringInherited from IXYSeriesSettings

Data field with the Y value.

More info: XY chart series: data fields

#valueYGrouped

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"Default "close"Inherited from IXYSeriesSettings

How a DateAxis with groupData combines the Y values of the data items it groups into one: "open" takes the first, "close" the last, "extreme" the one farthest from zero, and the rest as named.

More info: Date axis: dynamic data item grouping

#valueYShow

Type "valueYWorking" | "valueYChange" | "valueYChangePercent" | "valueYChangeSelection" | "valueYChangeSelectionPercent" | "valueYChangePrevious" | "valueYChangePreviousPercent" | "valueYTotal" | "valueYTotalPercent" | "valueYSum"Default "valueYWorking"Inherited from IXYSeriesSettings

Which form of the Y value the series plots on a ValueAxis: the value itself ("valueYWorking"), or one worked out from it, such as its change since the first visible data item ("valueYChangeSelection") or its percent of the total ("valueYTotalPercent").

More info: XY chart series: data fields

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

#xAxis

Type DateAxisInherited from IDrawingSeriesSettings

The date axis the drawings' points are placed on.

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

#yAxis

Type ValueAxisInherited from IDrawingSeriesSettings

The value axis the drawings' points are placed on.