Skip to content
amCharts 5

CalloutSeries

Type class

Data item

CalloutSeries uses data items of type ICalloutSeriesDataItem.

Sources

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

// Import CalloutSeries
import * as am5stock from "@amcharts/amcharts5/stock";


// Create CalloutSeries
am5stock.CalloutSeries.new(root, {
  // ... config if applicable
});

Inheritance

CalloutSeries extends LabelSeries.

CalloutSeries is not extended by any other symbol.

Settings

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

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

labelFill

Type ColorInherited from ILabelSeriesSettings

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

labelFontFamily

Type undefined | stringInherited from ILabelSeriesSettings

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 | undefinedInherited from ILabelSeriesSettings

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

labelFontStyle

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

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"Inherited from ILabelSeriesSettings

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

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.

Private settings

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

169 inherited items
adjustedStartIndex

Read onlyType undefined | numberInherited from ISeriesPrivate

allowChangeSnap

Read onlyType undefined | false | trueInherited from IDrawingSeriesPrivate

baseValueSeries

Read onlyType SeriesInherited from ISeriesPrivate

customValueAbsoluteSum

Read onlyType undefined | numberInherited from ISeriesPrivate

customValueAverage

Read onlyType undefined | numberInherited from ISeriesPrivate

customValueClose

Read onlyType undefined | numberInherited from ISeriesPrivate

customValueCount

Read onlyType undefined | numberInherited from ISeriesPrivate

customValueHigh

Read onlyType undefined | numberInherited from ISeriesPrivate

customValueLow

Read onlyType undefined | numberInherited from ISeriesPrivate

customValueOpen

Read onlyType undefined | numberInherited from ISeriesPrivate

customValueSum

Read onlyType undefined | numberInherited from ISeriesPrivate

doNotUpdateLegend

Read onlyType undefined | false | trueInherited from IXYSeriesPrivate

endIndex

Read onlyType undefined | numberInherited from ISeriesPrivate

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.

highValueXAbsoluteSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXAbsoluteSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXAverage

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXAverageSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXClose

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXCloseSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXCount

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXCountSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXhigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXHigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXhighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXHighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXLow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXLowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueXSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYAbsoluteSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYAbsoluteSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYAverage

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYAverageSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYClose

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYCloseSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYCount

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYCountSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYhigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYHigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYhighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYHighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYLow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYLowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

highValueYSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

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.

input

Read onlyType HTMLTextAreaElementInherited from ILabelSeriesPrivate

inputContainer

Read onlyType HTMLDivElementInherited from ILabelSeriesPrivate

label

Read onlyType EditableLabelInherited from ILabelSeriesPrivate

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.

lowValueXAbsoluteSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXAbsoluteSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXAverage

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXAverageSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXClose

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXCloseSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXCount

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXCountSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXHigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXHighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXlow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXLow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXlowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXLowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueXSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYAbsoluteSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYAbsoluteSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYAverage

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYAverageSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYClose

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYCloseSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYCount

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYCountSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYHigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYHighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYlow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYLow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYlowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYLowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

lowValueYSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

maxX

Read onlyType undefined | numberInherited from IXYSeriesPrivate

maxY

Read onlyType undefined | numberInherited from IXYSeriesPrivate

minX

Read onlyType undefined | numberInherited from IXYSeriesPrivate

minY

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXAbsoluteSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXAbsoluteSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXAverage

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXAverageSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXClose

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXCloseSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXCount

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXCountSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXHigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXHighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXLow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXLowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXOpen

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXOpenSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueXSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYAbsoluteSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYAbsoluteSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYAverage

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYAverageSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYClose

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYCloseSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYCount

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYCountSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYHigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYHighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYLow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYLowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYOpen

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYOpenSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

openValueYSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

outOfSelection

Read onlyType undefined | false | trueInherited from IXYSeriesPrivate

selectionMaxX

Read onlyType undefined | numberInherited from IXYSeriesPrivate

selectionMaxY

Read onlyType undefined | numberInherited from IXYSeriesPrivate

selectionMinX

Read onlyType undefined | numberInherited from IXYSeriesPrivate

selectionMinY

Read onlyType undefined | numberInherited from IXYSeriesPrivate

showingTooltip

Read onlyType undefined | false | trueInherited from ISpritePrivate

true while the element shows its tooltip.

startIndex

Read onlyType undefined | numberInherited from ISeriesPrivate

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.

valueAbsoluteSum

Read onlyType undefined | numberInherited from ISeriesPrivate

Sum of the absolute values of all data items (with calculateAggregates).

valueAverage

Read onlyType undefined | numberInherited from ISeriesPrivate

Average of all data items' values (with calculateAggregates).

valueClose

Read onlyType undefined | numberInherited from ISeriesPrivate

Value of the last data item that has one (with calculateAggregates).

valueCount

Read onlyType undefined | numberInherited from ISeriesPrivate

Number of data items with a value (with calculateAggregates).

valueHigh

Read onlyType undefined | numberInherited from ISeriesPrivate

Highest value of all data items (with calculateAggregates).

valueLow

Read onlyType undefined | numberInherited from ISeriesPrivate

Lowest value of all data items (with calculateAggregates).

valueOpen

Read onlyType undefined | numberInherited from ISeriesPrivate

Value of the first data item that has one (with calculateAggregates).

valueSum

Read onlyType undefined | numberInherited from ISeriesPrivate

Sum of all data items' values (with calculateAggregates).

valueXAbsoluteSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXAbsoluteSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXAverage

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXAverageSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXClose

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXCloseSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXCount

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXCountSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXHigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXHighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXLow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXLowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXOpen

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXOpenSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueXSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYAbsoluteSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYAbsoluteSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYAverage

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYAverageSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYClose

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYCloseSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYCount

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYCountSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYHigh

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYHighSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYLow

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYLowSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYOpen

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYOpenSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYSum

Read onlyType undefined | numberInherited from IXYSeriesPrivate

valueYSumSelection

Read onlyType undefined | numberInherited from IXYSeriesPrivate

Properties

className

StaticType stringDefault "CalloutSeries"

classNames

StaticType ArrayDefault LabelSeries.classNames.concat([CalloutSeries.className])

27 inherited items
adapters

Type AdaptersDefault new Adapters(this)Inherited from Entity

axisRanges

Type ListDefault new List()Inherited from XYSeries

Axis ranges of the series, added with createAxisRange().

More info: Axis ranges

bullets

Type ListDefault new List()Inherited from Series

Functions that make the series' bullets: each is called for every data item and returns a Bullet, or nothing for no bullet.

More info: Bullets

bulletsContainer

Type ContainerDefault Container.new(this._root, {width:p100, height:p100, position:"absolute"})._markC("width", "height", "position")Inherited from Series

The Container that holds the series' bullets.

chart

Type XYChart | undefinedInherited from XYSeries

children

Type ChildrenDefault new Children(this)Inherited from Container

The container's child elements.

circles

Type ListTemplateDefault this.addDisposer(new ListTemplate( Template.new({}), () => Circle._new(this._root, { }, [this.circles.template]), ))Inherited from DrawingSeries

Inner circles of the grips.

data

Type ListDataInherited from Component

The component's data: a list of data objects, each made into a data item.

More info: Data

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.

dataItems

Type ArrayInherited from Component

The component's data items.

enableDispose

Type booleanDefault trueInherited from Settings

Set to false to make dispose() do nothing.

events

Type SpriteEventDispatcherInherited from Sprite

fills

Type ListTemplateDefault new ListTemplate<Graphics>Inherited from LineSeries

Fills below the line segments. They are hidden by default: set visible and fillOpacity on fills.template to show them.

grips

Type ListTemplateDefault this.addDisposer(new ListTemplate( Template.new({}), () => Container._new(this._root, { themeTags: ["grip"], setStateOnChildren: true, draggable: true }, [this.grips.template]), ))Inherited from DrawingSeries

Grips on the drawings' points, which can be dragged to reshape them.

inited

Type booleanDefault falseInherited from Component

Becomes true after the component's first update.

mainContainer

Type ContainerDefault Container.new()Inherited from XYSeries

Container that holds the series' elements, such as its lines or columns.

mainDataItems

Type ArrayInherited from XYSeries

The series' original data items, before any grouping by a DateAxis.

outerCircles

Type ListTemplateDefault this.addDisposer(new ListTemplate( Template.new({}), () => Circle._new(this._root, { themeTags: ["outline"] }, [this.outerCircles.template]), ))Inherited from DrawingSeries

Outer circles of the grips.

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.

selectors

Type ListTemplateDefault this.addDisposer(new ListTemplate( Template.new({}), () => Rectangle._new(this._root, { themeTags: ["selector"] }, [this.selectors.template]), ))Inherited from DrawingSeries

Rectangles drawn around the selected drawings.

spriteResizer

Type SpriteResizerInherited from LabelSeries

The chart's SpriteResizer, which resizes and rotates labels.

states

Type StatesDefault new States(this)Inherited from Entity

strokes

Type ListTemplateDefault new ListTemplate<Graphics>Inherited from LineSeries

Line segments of the series. Configure them all, existing ones included, through strokes.template.

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

98 inherited items
addBullet(dataItem: DataItem,
bullet: Bullet)

Returns voidInherited from SeriesSince 5.6.0

Adds a bullet to one data item. Unlike series.bullets, it takes a Bullet instance, not a function.

More info: Bullets: adding directly to data item

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.

cancelDrawing()

Returns voidInherited from PolylineSeriesSince 5.9.0

Cancels the drawing in progress, deleting it.

clearDrawings()

Returns voidInherited from PolylineSeries

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

createAxisRange(axisDataItem: DataItem)

Returns IXYSeriesAxisRangeInherited from XYSeries

Adds an axis range to the series and returns it. Make its data item with the axis's makeDataItem().

More info: Axis ranges

deleteDrawing(id: string)

Returns voidInherited from DrawingSeriesSince 5.9.0

Deletes a drawing of this series by its ID.

deleteSelected()

Returns voidInherited from DrawingSeriesSince 5.9.0

Deletes the selected drawings of this series.

depth()

Returns numberInherited from Sprite

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

disableDrawing()

Returns voidInherited from PolylineSeries

disableErasing()

Returns voidInherited from DrawingSeries

Turns erasing off.

dispose()

Returns voidInherited from Settings

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

disposeDataItem(dataItem: DataItem)

Returns voidInherited from LabelSeries

disposeIndex(index: number)

Returns voidInherited from DrawingSeriesSince 5.7.7

Deletes the drawing at an index.

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

Returns voidInherited from Container

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

enableDrawing()

Returns voidInherited from DrawingSeries

Turns drawing on: the pointer on the plot area draws new drawings.

enableDrawingSelection(value: boolean)

Returns voidInherited from DrawingSeries

enableErasing()

Returns voidInherited from DrawingSeries

Turns erasing on: a click on a drawing deletes it.

endIndex()

Returns numberInherited from DrawingSeries

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

getContext(id: string)

Returns anyInherited from DrawingSeries

Returns the data context of a drawing, found by its ID.

getDataItemById(id: string)

Returns DataItem | undefinedInherited from Component

Returns the data item whose id matches, if any.

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/

getIndex(id: string)

Returns number | nullInherited from DrawingSeriesSince 5.8.4

Returns the index of the drawing with an ID, or null if there is none.

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/

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 XYSeries

Hides the series.

hideDataItem(dataItem: DataItem,
duration?: undefined | number)

Returns PromiseInherited from XYSeries

Hides a data item, animating its values to the value axis's base value.

hideTooltip()

Returns Promise | undefinedInherited from XYSeries

hover()

Returns voidInherited from Sprite

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

indexToDrawingId(index: number)

Returns string | undefinedInherited from DrawingSeries

Returns the ID of the drawing at an index.

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.

makeDataItem(data: IComponentDataItem,
dataContext?: any)

Returns DataItemInherited from Component

Creates and processes a data item, without adding it to dataItems.

markDirtyDrawings()

Returns voidInherited from DrawingSeries

Makes the StockChart dispatch drawingsupdated.

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.

markDirtyValues(_dataItem?: DataItem)

Returns voidInherited from ComponentSince 5.0.21

Makes the component redraw from its data 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

openUrl(dataItem: DataItem)

Returns voidInherited from SeriesSince 5.20.7

Opens a data item's URL in the window set by linkTarget.

Override to intercept links, e.g. in an editor.

pushDataItem(data: IComponentDataItem,
dataContext?: any)

Returns DataItemInherited from Component

Creates a data item straight from settings, not from data, and adds it to the component's data items.

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

resetExtremes()

Returns voidInherited from XYSeries

Clears the series' cached minimum and maximum values, which the axes use for their scale.

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.

selectDrawing(id: string,
keepSelection?: undefined | false | true)

Returns voidInherited from DrawingSeriesSince 5.9.0

Selects a drawing of this series by its ID. Works only while drawing selection is on (drawingSelectionEnabled of the StockChart).

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

setInteractive(value: boolean)

Returns voidInherited from DrawingSeries

Makes the drawings react to the pointer, or not.

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 XYSeries

Shows the series.

showDataItem(dataItem: DataItem,
duration?: undefined | number)

Returns PromiseInherited from XYSeries

Shows a data item, animating its values back from the base value.

showDataItemTooltip(dataItem: DataItem | undefined)

Returns voidInherited from XYSeries

Shows the series' tooltip for a data item, and shows that data item in the legend.

showTooltip(point?: IPoint)

Returns Promise | undefinedInherited from Sprite

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

startIndex()

Returns numberInherited from DrawingSeries

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.

toggleDrawing(enabled?: undefined | false | true)

Returns voidInherited from LabelSeries

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.

unselectAllDrawings()

Returns numberInherited from DrawingSeriesSince 5.9.0

Unselects all selected drawings of the whole StockChart, not only of this series.

unselectDrawing(id: string)

Returns voidInherited from DrawingSeriesSince 5.9.0

Unselects a drawing of this series by its ID.

unselectDrawings()

Returns numberInherited from DrawingSeriesSince 5.9.0

Unselects the selected drawings of this series.

updateData(data: Array)

Returns voidInherited from Component

Updates the data in place, keeping the existing data items: each object's values go into the data item at the same index. Extra objects are added as new data items, and data items beyond the new data are removed.

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 CalloutSeries object using its events.on() method. Read about adding event handlers.

23 inherited items
blur

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

Invoked when element loses focus.

boundschanged

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

The element's bounds changed.

click

Param { type: "click", target: CalloutSeries } & 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: CalloutSeries, newDataItem: DataItem | undefined, oldDataItem: DataItem | undefined }Inherited from ISpriteEvents

The element's data item changed.

datasetchanged

Param { type: "datasetchanged", target: CalloutSeries, id: string }Inherited from XYSeriesSince 5.1.1

The series switched to another data set, such as data grouped by another interval on a DateAxis. id names the new set.

datavalidated

Param { type: "datavalidated", target: CalloutSeries }Inherited from IComponentEvents

The component's data changed and was processed.

dblclick

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

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

dragged

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

The element moved while being dragged.

dragstart

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

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

dragstop

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

Dragging of the element stopped.

focus

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

Invoked when element gains focus.

globalpointerdown

Param { type: "globalpointerdown", target: CalloutSeries } & 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: CalloutSeries } & ISpritePointerEventInherited from ISpriteEvents

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

globalpointerup

Param { type: "globalpointerup", target: CalloutSeries } & 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: CalloutSeries } & ISpritePointerEventInherited from ISpriteEvents

The element was clicked with the middle mouse button.

pointerdown

Param { type: "pointerdown", target: CalloutSeries } & 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: CalloutSeries } & ISpritePointerEventInherited from ISpriteEvents

The pointer left the element.

pointerover

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

The pointer moved over the element.

pointerup

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

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

positionchanged

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

The element's position changed.

rightclick

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

The element was clicked with the right mouse button.

valueschanged

Param { type: "valueschanged", target: CalloutSeries }Inherited from IComponentEvents

Values of the component's data items changed.

wheel

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

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