Documentation

BaseColumnSeries

Type class

Base class for column-based series: ColumnSeries, CandlestickSeries, OHLCSeries and RadarColumnSeries.

Data item

BaseColumnSeries uses data items of type IBaseColumnSeriesDataItem.

Sources

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

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

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

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

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

Inheritance

BaseColumnSeries extends XYSeries.

BaseColumnSeries is extended by ColumnSeries, RadarColumnSeries, CurveColumnSeries.

Settings

Set these settings on a BaseColumnSeries object using its set() and setAll() methods.

Read about settings concept.

active
#

Type undefined | false | true

Inherited from ISpriteSettings

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

Type undefined | false | true

Default true

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

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

appearDelay
#

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

appearDuration
#

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

ariaChecked
#

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

Type undefined | string

Inherited from ISpriteSettings

aria-controls setting.
ariaCurrent
#

Type undefined | string

Inherited from ISpriteSettings

aria-current setting.

Click here for more info
@since 5.9.8

ariaExpanded
#

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

ariaHidden
#

Type undefined | false | true

Inherited from ISpriteSettings

aria-hidden setting.
ariaLabel
#

Type undefined | string

Inherited from ISpriteSettings

Label for the element to use for screen readers.

Click here for more info

ariaLive
#

Type AriaLive

Inherited from ISpriteSettings

aria-live setting.
ariaOrientation
#

Type undefined | string

Inherited from ISpriteSettings

aria-orientation setting.
ariaSelected
#

Type undefined | false | true

Inherited from ISpriteSettings

aria-selected setting.

Click here for more info
@since 5.9.8

ariaValueMax
#

Type undefined | string

Inherited from ISpriteSettings

aria-valuemax setting.
ariaValueMin
#

Type undefined | string

Inherited from ISpriteSettings

aria-valuemin setting.
ariaValueNow
#

Type undefined | string

Inherited from ISpriteSettings

aria-valuenow setting.
ariaValueText
#

Type undefined | string

Inherited from ISpriteSettings

aria-valuetext setting.
autoAppear
#

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

background
#

Type Graphics

Inherited from IContainerSettings

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

Click here for more info

baseAxis
#

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

blur
#

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

brightness
#

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

calculateAggregates
#

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the X category.

Click here for more info

categoryYField
#

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the Y category.

Click here for more info

centerX
#

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

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

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

clustered
#

Type undefined | false | true

Default true

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

colorByDataItem
#

Type undefined | false | true

Default false

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

@since 5.20.4

colors
#

Type ColorSet

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

contrast
#

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

crisp
#

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

cursorOverStyle
#

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

customValueField
#

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

Type DateFormatter | undefined

Inherited from ISpriteSettings

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

Click here for more info

disabled
#

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

Type undefined | false | true

Inherited from ISpriteSettings

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

Type DurationFormatter | undefined

Inherited from ISpriteSettings

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

Click here for more info

dx
#

Type undefined | number

Inherited from ISpriteSettings

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

Type undefined | number

Inherited from ISpriteSettings

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

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

exactLocationY
#

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

excludeFromAggregate
#

Type Array

Inherited from ISeriesSettings

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

@since 5.14.4

excludeFromTotal
#

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

Type undefined | false | true

Inherited from ISpriteSettings

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

Type Color

Inherited from ISeriesSettings

Series fill color.

Click here for more info

fillGradient
#

Type Gradient

Inherited from ISeriesSettings

Series fill gradient.

Click here for more info

fillPattern
#

Type Pattern

Inherited from ISeriesSettings

Series fill pattern.

Click here for more info
@since 5.10.0

focusable
#

Type undefined | false | true

Inherited from ISpriteSettings

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

Click here for more info

focusableGroup
#

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

forceHidden
#

Type undefined | false | true

Inherited from ISpriteSettings

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

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

groupDataCallback
#

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

groupDataDisabled
#

Type undefined | false | true

Inherited from IXYSeriesSettings

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

@since 5.0.19

groupDataWithOriginals
#

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

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.

Click here for more info

height
#

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

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

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the high X value.

Click here for more info

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 | string

Inherited from IXYSeriesSettings

Data field with the high Y value.

Click here for more info

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

html
#

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

hue
#

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

id
#

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

Type undefined | string

Inherited from ISeriesSettings

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

Type undefined | false | true

Default false

Inherited from IXYSeriesSettings

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

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

interactive
#

Type undefined | false | true

Inherited from ISpriteSettings

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

Type undefined | false | true

Default true

Inherited from IContainerSettings

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

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

interpolationEasing
#

Type $ease.Easing

Inherited from IComponentSettings

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

Click here for more info

invert
#

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

isMeasured
#

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

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

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

layout
#

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

legendDataItem
#

Type DataItem

Inherited from ISeriesSettings

The series' data item in a Legend.

@readonly

legendLabelText
#

Type undefined | string

Inherited from ISeriesSettings

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

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

Type undefined | string

Inherited from IXYSeriesSettings

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

Type undefined | string

Inherited from ISeriesSettings

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

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

locationX
#

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

locationY
#

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

lowLocationX
#

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

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the low X value.

Click here for more info

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 | string

Inherited from IXYSeriesSettings

Data field with the low Y value.

Click here for more info

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 | number

Inherited from ISpriteSettings

Bottom margin in pixels.
marginLeft
#

Type undefined | number

Inherited from ISpriteSettings

Left margin in pixels.
marginRight
#

Type undefined | number

Inherited from ISpriteSettings

Right margin in pixels.
marginTop
#

Type undefined | number

Inherited from ISpriteSettings

Top margin in pixels.
mask
#

Type Graphics | null

Inherited from IContainerSettings

An element whose shape clips the container's children.

Click here for more info

maskBullets
#

Type undefined | false | true

Default true

Inherited from IXYSeriesSettings

Clips the series' bullets to the plot area.
maskContent
#

Type undefined | false | true

Inherited from IContainerSettings

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

Type number | null

Inherited from ISpriteSettings

Maximum allowed height in pixels.
maxWidth
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed width in pixels.
minBulletDistance
#

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

minHeight
#

Type number | null

Inherited from ISpriteSettings

Minimum allowed height in pixels.
minWidth
#

Type number | null

Inherited from ISpriteSettings

Minimum allowed width in pixels.
name
#

Type undefined | string

Inherited from ISeriesSettings

Name of the series.
numberFormatter
#

Type NumberFormatter | undefined

Inherited from ISpriteSettings

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

Click here for more info

opacity
#

Type undefined | number

Default 1

Inherited from ISpriteSettings

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

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

openCategoryYField
#

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

openLocationX
#

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

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

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

openValueXGrouped
#

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

openValueXShow
#

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

openValueYField
#

Type undefined | string

Inherited from IXYSeriesSettings

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

Click here for more info

openValueYGrouped
#

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

openValueYShow
#

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

paddingBottom
#

Type undefined | number

Inherited from IContainerSettings

Bottom padding in pixels.
paddingLeft
#

Type undefined | number

Inherited from IContainerSettings

Left padding in pixels.
paddingRight
#

Type undefined | number

Inherited from IContainerSettings

Right padding in pixels.
paddingTop
#

Type undefined | number

Inherited from IContainerSettings

Top padding in pixels.
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 | true

Inherited from IContainerSettings

Lays out the children in reverse order.

@since 5.1.1

role
#

Type Role

Inherited from ISpriteSettings

Element's role.

Click here for more info

rotation
#

Type undefined | number

Default 0

Inherited from ISpriteSettings

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

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

scale
#

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

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

sequencedDelay
#

Type undefined | number

Inherited from ISeriesSettings

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

Click here for more info

sequencedInterpolation
#

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

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 | true

Default false

Inherited from IContainerSettings

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

Click here for more info

showTooltipOn
#

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

snapTooltip
#

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

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

stacked
#

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

stateAnimationDuration
#

Type undefined | number

Default 0

Inherited from IEntitySettings

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

0 switches at once.
stateAnimationEasing
#

Type $ease.Easing

Default out(cubic)

Inherited from IEntitySettings

Easing of the animated switch from one state to another.
stroke
#

Type Color

Inherited from ISeriesSettings

Series stroke color.

Click here for more info

strokeGradient
#

Type Gradient

Inherited from ISeriesSettings

Series stroke gradient.

Click here for more info

tabindexOrder
#

Type undefined | number

Inherited from ISpriteSettings

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

Click here for more info

templateField
#

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

themeTags
#

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

themeTagsSelf
#

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

themes
#

Type Array

Inherited from IEntitySettings

Themes applied to the element and everything inside it.
toggleKey
#

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

Type Tooltip

Inherited from ISpriteSettings

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

Type DataItem

Inherited from IXYSeriesSettings

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

@since 5.1.2

tooltipHTML
#

Type undefined | string

Inherited from ISpriteSettings

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

@since 5.2.11

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 IXYSeriesSettings

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

@since 5.0.16

tooltipPositionY
#

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

tooltipText
#

Type undefined | string

Inherited from ISpriteSettings

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

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

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

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

useLastColorForLegendMarker
#

Type undefined | false | true

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

@since 5.1.13

useSelectionExtremes
#

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

userData
#

Type any

Inherited from IEntitySettings

Any data of your own to keep with the element.
valueField
#

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

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the X value.

Click here for more info

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.

Click here for more info

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

Click here for more info

valueYField
#

Type undefined | string

Inherited from IXYSeriesSettings

Data field with the Y value.

Click here for more info

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.

Click here for more info

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

Click here for more info

verticalScrollbar
#

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

visible
#

Type undefined | false | true

Default true

Inherited from ISpriteSettings

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

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

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

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

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

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

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.
There are 176 inherited items currently hidden from this list.

Private settings

These are read-only settings accessible from a BaseColumnSeries object using its getPrivate() method.

Read about private settings.

adjustedStartIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
baseValueSeries
#

Read only

Type Series

Inherited from ISeriesPrivate
customValueAbsoluteSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
customValueAverage
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
customValueClose
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
customValueCount
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
customValueHigh
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
customValueLow
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
customValueOpen
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
customValueSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
doNotUpdateLegend
#

Read only

Type undefined | false | true

Inherited from IXYSeriesPrivate
endIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
focusable
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

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.

@since 5.3.16

highValueXAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXhigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueXhighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYhigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
highValueYhighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
htmlElement
#

Read only

Type HTMLDivElement

Inherited from IContainerPrivate

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

Read only

Type HTMLDivElement

Inherited from IContainerPrivate

A wrapper <div> for htmlElement.

@since 5.11.2

lastTooltipCoords
#

Read only

Type IPoint

Inherited from ISpritePrivate

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

@since 5.11.3

lowValueXAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXlow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueXlowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYlow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
lowValueYlowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
maxX
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
maxY
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
minX
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
minY
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXOpen
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXOpenSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueXSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYOpen
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYOpenSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
openValueYSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
outOfSelection
#

Read only

Type undefined | false | true

Inherited from IXYSeriesPrivate
selectionMaxX
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
selectionMaxY
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
selectionMinX
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
selectionMinY
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
showingTooltip
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

true while the element shows its tooltip.
startIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate
tooltipTarget
#

Read only

Type Graphics

Inherited from ISpritePrivate

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

Read only

Type undefined | false | true

Inherited from ISpritePrivate

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.

@since 5.5.0

valueAbsoluteSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

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

Read only

Type undefined | number

Inherited from ISeriesPrivate

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

Read only

Type undefined | number

Inherited from ISeriesPrivate

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

Read only

Type undefined | number

Inherited from ISeriesPrivate

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

Read only

Type undefined | number

Inherited from ISeriesPrivate

Highest value of all data items (with calculateAggregates).
valueLow
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

Lowest value of all data items (with calculateAggregates).
valueOpen
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

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

Read only

Type undefined | number

Inherited from ISeriesPrivate

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

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXOpen
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXOpenSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueXSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYOpen
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYOpenSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
valueYSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate
There are 165 inherited items currently hidden from this list.

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity
axisRanges
#

Type List

Default new List()

Inherited from XYSeries

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

Click here for more info

bullets
#

Type List

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

Click here for more info

bulletsContainer
#

Type Container

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

Inherited from XYSeries
children
#

Type Children

Default new Children(this)

Inherited from Container

The container's child elements.
className
#

Static

Type string

Default "BaseColumnSeries"
classNames
#

Static

Type Array

Default "BaseColumnSeries", "XYSeries", "Series", "Component", "Container", "Sprite", "Entity"
columns
#

Type ListTemplate

Columns of the series. Configure them all through columns.template.
data
#

Type ListData

Inherited from Component

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

Click here for more info

dataItem
#

Type DataItem | undefined

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

Inherited from Component

The component's data items.
enableDispose
#

Type boolean

Default true

Inherited from Settings

Set to false to make dispose() do nothing.
events
#

Type SpriteEventDispatcher

Inherited from Sprite
inited
#

Type boolean

Default false

Inherited from Component

Becomes true after the component's first update.
mainContainer
#

Type Container

Default Container.new()

Inherited from XYSeries

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

Type Array

Inherited from XYSeries

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

Type Container | undefined

Inherited from Sprite

Parent Container of this element.
root
#

Type Root

Inherited from Entity

The Root the object belongs to.

@readonly
@since 5.0.6

states
#

Type States

Default new States(this)

Inherited from Entity
template
#

Type Template | undefined

Inherited from Entity

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

Type number

Default ++counter

Inherited from Settings

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

Type Container | undefined

Inherited from Sprite
There are 20 inherited items currently hidden from this list.

Methods

addBullet(

dataItem: DataItem,
bullet: Bullet

)

#

Returns void

Inherited from Series

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

Click here for more info
@since 5.6.0

allChildren()

#

Returns Array

Inherited from Container

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

animate(

options: AnimationOptions

)

#

Returns Animation

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

Click here for more info

appear(

duration?: undefined | number,
delay?: undefined | number

)

#

Returns Promise

Inherited from Sprite

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

compositeOpacity()

#

Returns number

Inherited from Sprite

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

@since 5.2.11

compositeRotation()

#

Returns number

Inherited from Sprite

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

@since 5.9.2

compositeScale()

#

Returns number

Inherited from Sprite

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

@since 5.9.2

contentHeight()

#

Returns number

Inherited from Container

contentWidth()

#

Returns number

Inherited from Container

createAxisRange(

axisDataItem: DataItem

)

#

Returns IBaseColumnSeriesAxisRange

depth()

#

Returns number

Inherited from Sprite

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

dispose()

#

Returns void

Inherited from Settings

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

eachChildren(

f: ( child: Sprite) => void

)

#

Returns void

Inherited from Container

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

endIndex()

#

Returns number

Inherited from Series

Returns the index after the last data item in the visible range.

get(

key: Key,
fallback: F

)

#

Returns NonNullable | F

Inherited from Entity

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

Click here for more info

getDataItemById(

id: string

)

#

Returns DataItem | undefined

Inherited from Component

Returns the data item whose id matches, if any.

getDateFormatter()

#

Returns DateFormatter

Inherited from Sprite

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

Click here for more info

getDurationFormatter()

#

Returns DurationFormatter

Inherited from Sprite

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

Click here for more info

getNumberFormatter()

#

Returns NumberFormatter

Inherited from Sprite

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

Click here for more info

getTooltip()

#

Returns Tooltip | undefined

Inherited from Sprite

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

has(

key: Key

)

#

Returns boolean

Inherited from Settings

Returns true if setting key is set.

Click here for more info

height()

#

Returns number

Inherited from Sprite

Returns the element's height in pixels.

hide(

duration?: undefined | number

)

#

Returns Promise

Inherited from XYSeries

Hides the series.

hideDataItem(

dataItem: DataItem,
duration?: undefined | number

)

#

Returns Promise

Hides a data item, along with its column.

hideTooltip()

#

Returns void

Inherited from XYSeries

hover()

#

Returns void

Inherited from Sprite

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

innerHeight()

#

Returns number

Inherited from Container

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

innerWidth()

#

Returns number

Inherited from Container

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

isDisposed()

#

Returns boolean

Inherited from Settings

Returns true if the object has been disposed.

isDragging()

#

Returns boolean

Inherited from Sprite

Returns true while the element is being dragged.

isFocus()

#

Returns boolean

Inherited from Sprite

Returns true if this element does currently have focus.

isHidden()

#

Returns boolean

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

Inherited from Sprite

Returns true while the element's hiding animation plays.

isHover()

#

Returns boolean

Inherited from Sprite

Returns true if the pointer is over the element.

isShowing()

#

Returns boolean

Inherited from Sprite

Returns true while the element's showing animation plays.

isType(

type: string

)

#

Returns this

Inherited from Entity

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

isVisible()

#

Returns boolean

Inherited from Sprite

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

isVisibleDeep()

#

Returns boolean

Inherited from Sprite

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

@since 5.2.7

makeDataItem(

data: IBaseColumnSeriesDataItem,
dataContext?: any

)

#

Returns DataItem

Inherited from Component

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

markDirtyKey(

key: Key

)

#

Returns void

Inherited from Sprite

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

markDirtyValues(

_dataItem?: DataItem

)

#

Returns void

Inherited from Component

Makes the component redraw from its data on the next frame.

@since 5.0.21

maxHeight()

#

Returns number

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

Inherited 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

)

#

Static

Returns T

Inherited from Entity

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

Click here for more info

off(

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

)

#

Returns void

Inherited from Settings

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

Click here for more info
@since 5.9.2

offDebounced(

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

)

#

Returns void

Inherited from Settings

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

Click here for more info

offDebouncedPrivate(

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

)

#

Returns void

Inherited from Settings

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

Click here for more info

offPrivate(

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

)

#

Returns void

Inherited from Settings

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

Click here for more info
@since 5.9.2

on(

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

)

#

Returns IDisposer

Inherited from Settings

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

Click here for more info

onDebounced(

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

)

#

Returns IDisposer

Inherited from Settings

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

Click here for more info

onPrivate(

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

)

#

Returns IDisposer

Inherited from Settings

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

Click here for more info

onPrivateDebounced(

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

)

#

Returns IDisposer

Inherited from Settings

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

Click here for more info

once(

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

)

#

Returns IDisposer

Inherited from Settings

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

Click here for more info
@since 5.20.4

onceDebounced(

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

)

#

Returns IDisposer

Inherited from Settings

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

Click here for more info
@since 5.20.4

openUrl(

dataItem: DataItem

)

#

Returns void

Inherited from Series

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

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

@since 5.20.7

pushDataItem(

data: IBaseColumnSeriesDataItem,
dataContext?: any

)

#

Returns DataItem

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

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

Click here for more info

removeAll()

#

Returns void

Inherited from Settings

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

Click here for more info

resetExtremes()

#

Returns void

Inherited from XYSeries

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

scrollToChild(

child: Sprite

)

#

Returns void

Inherited from Container

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

@since 5.10.5

set(

key: Key,
value: Value

)

#

Returns Value

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

Click here for more info

setAll(

settings: Partial

)

#

Returns void

Inherited from Settings

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

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

#

Returns IDisposer

Inherited from Entity

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

show(

duration?: undefined | number

)

#

Returns Promise

Inherited from XYSeries

Shows the series.

showDataItem(

dataItem: DataItem,
duration?: undefined | number

)

#

Returns Promise

Shows a data item, along with its column.

showDataItemTooltip(

dataItem: DataItem | undefined

)

#

Returns void

Inherited from XYSeries

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

showTooltip(

point?: IPoint

)

#

Returns Promise | undefined

Inherited from Sprite

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

startIndex()

#

Returns number

Inherited from Series

Returns the index of the first data item in the visible range.

toBack()

#

Returns void

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

Inherited from Sprite

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

toGlobal(

point: IPoint

)

#

Returns IPoint

Inherited from Sprite

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

toLocal(

point: IPoint

)

#

Returns IPoint

Inherited from Sprite

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

unhover()

#

Returns void

Inherited from Sprite

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

updateData(

data: Array

)

#

Returns void

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

Inherited from Sprite

Returns the element's width in pixels.

x()

#

Returns number

Inherited from Sprite

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

y()

#

Returns number

Inherited from Sprite

Returns the element's Y position in pixels, relative to its parent, without dy.
There are 74 inherited items currently hidden from this list.

Events

Add event handlers to BaseColumnSeries object using its events.on() method.

Read about adding event handlers.

#blur

Param { originalEvent: FocusEvent,
  target: Sprite,
  type: "blur",
  target: this }

Inherited from XYSeries

Invoked when element loses focus.
#boundschanged

Param { type: "boundschanged",
  target: this }

Inherited from XYSeries

The element's bounds changed.
#click

Param { type: "click",
  target: this }

Inherited from XYSeries

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

Param { newDataItem: DataItem | undefined,
  oldDataItem: DataItem | undefined,
  type: "dataitemchanged",
  target: this }

Inherited from XYSeries

The element's data item changed.
#datasetchanged

Param { id: string,
  type: "datasetchanged",
  target: this }

Inherited from XYSeries

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

@since 5.1.1

#datavalidated

Param { type: "datavalidated",
  target: this }

Inherited from XYSeries

The component's data changed and was processed.
#dblclick

Param { type: "dblclick",
  target: this }

Inherited from XYSeries

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

Param { type: "dragged",
  target: this }

Inherited from XYSeries

The element moved while being dragged.
#dragstart

Param { type: "dragstart",
  target: this }

Inherited from XYSeries

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

Param { type: "dragstop",
  target: this }

Inherited from XYSeries

Dragging of the element stopped.
#focus

Param { originalEvent: FocusEvent,
  target: Sprite,
  type: "focus",
  target: this }

Inherited from XYSeries

Invoked when element gains focus.
#globalpointerdown

Param { type: "globalpointerdown",
  target: this }

Inherited from XYSeries

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

Param { type: "globalpointermove",
  target: this }

Inherited from XYSeries

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

Param { type: "globalpointerup",
  target: this }

Inherited from XYSeries

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

Param { type: "middleclick",
  target: this }

Inherited from XYSeries

The element was clicked with the middle mouse button.
#pointerdown

Param { type: "pointerdown",
  target: this }

Inherited from XYSeries

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

Param { type: "pointerout",
  target: this }

Inherited from XYSeries

The pointer left the element.
#pointerover

Param { type: "pointerover",
  target: this }

Inherited from XYSeries

The pointer moved over the element.
#pointerup

Param { type: "pointerup",
  target: this }

Inherited from XYSeries

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

Param { type: "positionchanged",
  target: this }

Inherited from XYSeries

The element's position changed.
#rightclick

Param { type: "rightclick",
  target: this }

Inherited from XYSeries

The element was clicked with the right mouse button.
#valueschanged

Param { type: "valueschanged",
  target: this }

Inherited from XYSeries

Values of the component's data items changed.
#wheel

Param { originalEvent: WheelEvent,
  point: IPoint,
  type: "wheel",
  target: this }

Inherited from XYSeries

The mouse wheel turned while the pointer was over the element. Also dispatched on its parents.
There are 23 inherited items currently hidden from this list.