ICurveColumnSeriesSettings

Type undefined | false | true

Inherited from ISpriteSettings

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

Type undefined | false | true

Default true


Inherited from IBaseColumnSeriesSettings

Places bullets on the visible part of a column that runs past the plot area, instead of on the whole column.

Type Array

Inherited from IEntitySettings

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" }
]);

@since 5.20.8

Type undefined | number

Default 0

Inherited from ISpriteSettings

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

@since 5.21.0

Type undefined | number

Inherited from ISpriteSettings

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

@since 5.21.0

Type undefined | false | true

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

Type undefined | string

Inherited from ISpriteSettings

aria-controls setting.

Type undefined | string

Inherited from ISpriteSettings

aria-current setting.

Click here for more info
@since 5.9.8

Type undefined | false | true

Inherited from ISpriteSettings

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

Click here for more info
@since 5.21.0

Type undefined | false | true

Inherited from ISpriteSettings

aria-hidden setting.

Type undefined | string

Inherited from ISpriteSettings

Label for the element to use for screen readers.

Click here for more info

Type AriaLive

Inherited from ISpriteSettings

aria-live setting.

Type undefined | string

Inherited from ISpriteSettings

aria-orientation setting.

Type undefined | false | true

Inherited from ISpriteSettings

aria-selected setting.

Click here for more info
@since 5.9.8

Type undefined | string

Inherited from ISpriteSettings

aria-valuemax setting.

Type undefined | string

Inherited from ISpriteSettings

aria-valuemin setting.

Type undefined | string

Inherited from ISpriteSettings

aria-valuenow setting.

Type undefined | string

Inherited from ISpriteSettings

aria-valuetext setting.

Type undefined | false | true

Default false

Inherited from ISpriteSettings

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 });

Click here for more info
@since 5.21.0

Type Graphics

Inherited from IContainerSettings

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

Click here for more info

Type IXYAxis

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

Click here for more info

Type undefined | number

Inherited from ISpriteSettings

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

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | number

Inherited from ISpriteSettings

Brightness.

• 0 - completely black
• 1 - no changes (default)
• >1 - brighter IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | false | true

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the X category.

Click here for more info

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the Y category.

Click here for more info

Type number | Percent

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

Type number | Percent

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

Type undefined | string

Inherited from ISpriteSettings

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

@since 5.10.8

Type undefined | false | true

Default true

Inherited from IBaseColumnSeriesSettings

Places the columns side by side with those of the other clustered column series on the same base axis, sharing each cell. With false, the columns take the whole cell and can overlap the others.

Click here for more info

Type undefined | false | true

Default false

Inherited from IBaseColumnSeriesSettings

Gives each column its own color from colors, instead of one color for the whole series.

@since 5.20.4

Type ColorSet

Inherited from IBaseColumnSeriesSettings

Colors for the columns when colorByDataItem is set. If not set, the series makes its own ColorSet, separate from the chart's.

@since 5.20.4

Type undefined | number

Inherited from ISpriteSettings

Contrast.

• 0 - completely gray
• 1 - no changes (default)
• >1 - more contrast IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | false | true

Default false

Inherited from ISpriteSettings

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.

@since 5.3.0

Type undefined | string

Inherited from ISpriteSettings

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

"pointer".

Click here for more info

Type undefined | string

Inherited from ISeriesSettings

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

Type DateFormatter | undefined

Inherited from ISpriteSettings

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

Click here for more info

Type undefined | false | true

Inherited from ISpriteSettings

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

Type undefined | false | true

Inherited from ISpriteSettings

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

Type DurationFormatter | undefined

Inherited from ISpriteSettings

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

Click here for more info

Type undefined | number

Inherited from ISpriteSettings

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

Type undefined | number

Inherited from ISpriteSettings

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

Type undefined | false | true

Default false

Inherited from IXYSeriesSettings

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.

@since 5.13.0

Type undefined | false | true

Default false

Inherited from IXYSeriesSettings

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

@since 5.13.0

Type Array

Inherited from ISeriesSettings

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

@since 5.14.4

Type undefined | false | true

Default false


Inherited from IXYSeriesSettings

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

Type undefined | false | true

Inherited from ISpriteSettings

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

Type Color

Inherited from ISeriesSettings

Series fill color.

Click here for more info

Type Gradient

Inherited from ISeriesSettings

Series fill gradient.

Click here for more info

Type Pattern

Inherited from ISeriesSettings

Series fill pattern.

Click here for more info
@since 5.10.0

Type undefined | false | true

Inherited from ISpriteSettings

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

Click here for more info

Type string | number

Inherited from ISpriteSettings

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.

Click here for more info
@since 5.0.6

Type undefined | false | true

Inherited from ISpriteSettings

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

Type undefined | false | true

Inherited from ISpriteSettings

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

@since 5.0.21

Type undefined | ( dataItem: DataItem, interval: ITimeInterval) => void

Inherited from IXYSeriesSettings

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

Click here for more info
@since 5.1.11

Type undefined | false | true

Inherited from IXYSeriesSettings

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

@since 5.0.19

Type undefined | false | true

Default false


Inherited from IXYSeriesSettings

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

@since 5.1.11

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.

Click here for more info

Type number | Percent | null

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

Type undefined | number

Default 0.5


Inherited from IXYSeriesSettings

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

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

Type undefined | number

Default 0.5


Inherited from IXYSeriesSettings

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

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the high X value.

Click here for more info

Type "open" | "close" | "high" | "average" | "sum" | "extreme"

Default "high"


Inherited from IXYSeriesSettings

How grouping combines the high X values; see valueXGrouped.

Type "highValueXWorking" | "highValueXChange" | "highValueXChangePercent" | "highValueXChangeSelection" | "highValueXChangeSelectionPercent" | "highValueXChangePrevious" | "highValueXChangePreviousPercent"

Inherited from IXYSeriesSettings

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the high Y value.

Click here for more info

Type "open" | "close" | "high" | "average" | "sum" | "extreme"

Default "high"


Inherited from IXYSeriesSettings

How grouping combines the high Y values; see valueYGrouped.

Type "highValueYWorking" | "highValueYChange" | "highValueYChangePercent" | "highValueYChangeSelection" | "highValueYChangeSelectionPercent" | "highValueYChangePrevious" | "highValueYChangePreviousPercent"

Inherited from IXYSeriesSettings

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

Type undefined | false | true

Inherited from ISpriteSettings

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

Click here for more info

Type undefined | string

Inherited from IContainerSettings

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

Click here for more info
@since 5.2.11

Type undefined | number

Inherited from ISpriteSettings

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

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | string

Inherited from IEntitySettings

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

Type undefined | string

Inherited from ISeriesSettings

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

Type undefined | false | true

Default false


Inherited from IXYSeriesSettings

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

Type undefined | false | true

Default false

Inherited from IEntitySettings

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

@since 5.15.6

Type undefined | false | true

Inherited from ISpriteSettings

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

Type undefined | false | true

Default true


Inherited from IContainerSettings

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

Type undefined | number

Default 0


Inherited from IComponentSettings

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

Click here for more info

Type $ease.Easing

Inherited from IComponentSettings

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

Click here for more info

Type undefined | number

Inherited from ISpriteSettings

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

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | false | true

Default true


Inherited from ISpriteSettings

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

Type undefined | number

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

Type IMargin

Inherited from ISpriteSettings

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

@since @5.2.39

Type Layout | null

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

Click here for more info

Type DataItem

Inherited from ISeriesSettings

The series' data item in a Legend.

@readonly

Type undefined | string

Inherited from ISeriesSettings

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

Type undefined | string

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

Type undefined | string

Inherited from IXYSeriesSettings

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

Type undefined | string

Inherited from ISeriesSettings

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

Type undefined | string

Default "_self"

Inherited from ISeriesSettings

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

@since 5.20.7

Type undefined | number

Default 0.5


Inherited from IXYSeriesSettings

Horizontal location of the data point relative to its cell.

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

Click here for more info

Type undefined | number

Default 0.5


Inherited from IXYSeriesSettings

Vertical location of the data point relative to its cell.

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

Click here for more info

Type undefined | number

Default 0.5


Inherited from IXYSeriesSettings

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

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

Type undefined | number

Default 0.5


Inherited from IXYSeriesSettings

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

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the low X value.

Click here for more info

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Default "low"


Inherited from IXYSeriesSettings

How grouping combines the low X values; see valueXGrouped.

Type "lowValueXWorking" | "lowValueXChange" | "lowValueXChangePercent" | "lowValueXChangeSelection" | "lowValueXChangeSelectionPercent" | "lowValueXChangePrevious" | "lowValueXChangePreviousPercent"

Inherited from IXYSeriesSettings

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the low Y value.

Click here for more info

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Default "low"


Inherited from IXYSeriesSettings

How grouping combines the low Y values; see valueYGrouped.

Type "lowValueYWorking" | "lowValueYChange" | "lowValueYChangePercent" | "lowValueYChangeSelection" | "lowValueYChangeSelectionPercent" | "lowValueYChangePrevious" | "lowValueYChangePreviousPercent"

Inherited from IXYSeriesSettings

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

Type undefined | number

Inherited from ISpriteSettings

Bottom margin in pixels.

Type undefined | number

Inherited from ISpriteSettings

Left margin in pixels.

Type undefined | number

Inherited from ISpriteSettings

Right margin in pixels.

Type undefined | number

Inherited from ISpriteSettings

Top margin in pixels.

Type Graphics | null

Inherited from IContainerSettings

An element whose shape clips the container's children.

Click here for more info

Type undefined | false | true

Default true


Inherited from IXYSeriesSettings

Clips the series' bullets to the plot area.

Type undefined | false | true

Inherited from IContainerSettings

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

Type number | null

Inherited from ISpriteSettings

Maximum allowed height in pixels.

Type number | null

Inherited from ISpriteSettings

Maximum allowed width in pixels.

Type undefined | number

Inherited from IXYSeriesSettings

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

Click here for more info

Type number | null

Inherited from ISpriteSettings

Minimum allowed height in pixels.

Type number | null

Inherited from ISpriteSettings

Minimum allowed width in pixels.

Type undefined | string

Inherited from ISeriesSettings

Name of the series.

Type NumberFormatter | undefined

Inherited from ISpriteSettings

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

Click here for more info

Type undefined | number

Default 1


Inherited from ISpriteSettings

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

Type undefined | string

Inherited from IXYSeriesSettings

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

Click here for more info

Type undefined | string

Inherited from IXYSeriesSettings

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

Click here for more info

Type undefined | number

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

Type undefined | number

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

Type undefined | string

Inherited from IXYSeriesSettings

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

Click here for more info

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Default "open"


Inherited from IXYSeriesSettings

How grouping combines the open X values; see valueXGrouped.

Click here for more info

Type "openValueXWorking" | "openValueXChange" | "openValueXChangePercent" | "openValueXChangeSelection" | "openValueXChangeSelectionPercent" | "openValueXChangePrevious" | "openValueXChangePreviousPercent"

Inherited from IXYSeriesSettings

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

Click here for more info

Type undefined | string

Inherited from IXYSeriesSettings

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

Click here for more info

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Default "open"


Inherited from IXYSeriesSettings

How grouping combines the open Y values; see valueYGrouped.

Click here for more info

Type "openValueYWorking" | "openValueYChange" | "openValueYChangePercent" | "openValueYChangeSelection" | "openValueYChangeSelectionPercent" | "openValueYChangePrevious" | "openValueYChangePreviousPercent"

Inherited from IXYSeriesSettings

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

Click here for more info

Type undefined | number

Inherited from IContainerSettings

Bottom padding in pixels.

Type undefined | number

Inherited from IContainerSettings

Left padding in pixels.

Type undefined | number

Inherited from IContainerSettings

Right padding in pixels.

Type undefined | number

Inherited from IContainerSettings

Top padding in pixels.

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

Type undefined | false | true

Inherited from IContainerSettings

Lays out the children in reverse order.

@since 5.1.1

Type Role

Inherited from ISpriteSettings

Element's role.

Click here for more info

Type undefined | number

Default 0


Inherited from ISpriteSettings

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

Type undefined | number

Inherited from ISpriteSettings

Saturation.

• 0 - grayscale
• 1 - no changes (default)
• >1 - more saturated IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | number

Default 1


Inherited from ISpriteSettings

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

Type undefined | number

Inherited from ISpriteSettings

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

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

Type undefined | number

Inherited from ISeriesSettings

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

Click here for more info

Type undefined | false | true

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

Click here for more info

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.

Type undefined | false | true

Default false


Inherited from IContainerSettings

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

Click here for more info

Type "hover" | "always" | "click"

Default "hover"

Inherited from ISpriteSettings

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.

Click here for more info
@since 5.0.16

Type undefined | false | true

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

Type undefined | false | true

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

Click here for more info

Type undefined | false | true

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

Click here for more info

Type undefined | number

Default 0


Inherited from IEntitySettings

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

0 switches at once.

Type $ease.Easing

Default out(cubic)


Inherited from IEntitySettings

Easing of the animated switch from one state to another.

Type Color

Inherited from ISeriesSettings

Series stroke color.

Click here for more info

Type Gradient

Inherited from ISeriesSettings

Series stroke gradient.

Click here for more info

Type undefined | number

Inherited from ISpriteSettings

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

Click here for more info

Type undefined | string

Inherited from ISpriteSettings

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

Click here for more info

Type Array

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

Click here for more info

Type Array

Inherited from IEntitySettings

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

Click here for more info

Type Array

Inherited from IEntitySettings

Themes applied to the element and everything inside it.

Type "disabled" | "active" | "none" | undefined

Inherited from ISpriteSettings

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

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

Type Tooltip

Inherited from ISpriteSettings

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

Type DataItem

Inherited from IXYSeriesSettings

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

@since 5.1.2

Type undefined | string

Inherited from ISpriteSettings

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

@since 5.2.11

Type "fixed" | "pointer"

Default "fixed"


Inherited from ISpriteSettings

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

Type "open" | "value" | "low" | "high"

Default "value"

Inherited from IXYSeriesSettings

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

@since 5.0.16

Type "open" | "value" | "low" | "high"

Default "value"

Inherited from IXYSeriesSettings

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

@since 5.0.16

Type undefined | string

Inherited from ISpriteSettings

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

Type number | Percent

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

Type number | Percent

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

Type undefined | string

Inherited from ISeriesSettings

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.

@since 5.20.7

Type undefined | false | true

Inherited from IBaseColumnSeriesSettings

Colors the legend marker like the last visible column, instead of with the series' fill and stroke.

@since 5.1.13

Type undefined | false | true

Inherited from IXYSeriesSettings

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

@since 5.10.11

Type any

Inherited from IEntitySettings

Any data of your own to keep with the element.

Type undefined | string

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the X value.

Click here for more info

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.

Click here for more info

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

Click here for more info

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the Y value.

Click here for more info

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.

Click here for more info

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

Click here for more info

Type Scrollbar

Inherited from IContainerSettings

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

Click here for more info

Type undefined | false | true

Default true


Inherited from ISpriteSettings

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

Type undefined | false | true

Inherited from ISpriteSettings

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

Type number | Percent | null

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

Type number | Percent | null

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

Type IXYAxis

Inherited from IXYSeriesSettings

The X axis the series is plotted against. Must be set when creating the series; it can be switched to another axis of the same type later.

Type number | Percent | null

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

Type IXYAxis

Inherited from IXYSeriesSettings

The Y axis the series is plotted against. Must be set when creating the series; it can be switched to another axis of the same type later.