IGanttDateAxisSettings

active #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Applies the element's `"active"` state while `true`.
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
autoZoom #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IValueAxisSettings` Rescales the axis to fit the values in view as the chart zooms along the other axis. Works only when that axis is not a plain `ValueAxis`: a `DateAxis` or a `CategoryAxis`, for example. @since 5.2.20
background #	Type `Graphics` Inherited from `IContainerSettings` Element drawn behind the container's content, sized to fill the container. Click here for more info
baseInterval #	Type `ITimeInterval` Inherited from `IDateAxisSettings` The time interval of the data, such as `{ timeUnit: "day", count: 1 }` for daily data. Each data item takes up one such period on the axis. Click here for more info
baseValue #	Type `undefined` \| `number` Default `0` Inherited from `IValueAxisSettings` The value columns grow from, splitting "positive" from "negative" values. Its grid line gets the `"base"` theme tag. 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
bullet #	Type `undefined` \| ( root: `Root`, axis: `Axis`, dataItem: `DataItem`) => `AxisBullet` Inherited from `IAxisSettings` Function that creates an `AxisBullet` for each of the axis's cells, such as each category. Axis ranges get none. Click here for more info
calculateTotals #	Type `undefined` \| `false` \| `true` Inherited from `IValueAxisSettings` Calculates totals across the axis's series for each data item in view: `valueYTotal`, `valueYSum` and `valueYTotalPercent` (or the `valueX` ones on an X axis), as used by 100% stacked charts. Series with `excludeFromTotal` are left out. 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
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
dateFormats #	Type `undefined` \| `object` Inherited from `IDateAxisSettings` Date formats for labels, by the time unit of the grid, such as `"day"`. Click here for more info
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.
end #	Type `undefined` \| `number` Default `1` Inherited from `IAxisSettings` End of the visible (zoomed) part of the axis: `0` is the start of the axis, `1` the end. Set it to pre-zoom: `0.9` hides the last 10%. Click here for more info
endLocation #	Type `undefined` \| `number` Default `1` Inherited from `IDateAxisSettings` Where within the last period the axis ends, from `0` (its start) to `1` (its end): `0.5` cuts off the second half of the last period.
exportable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If `false`, the element is left out of exported images of the chart.
extraMax #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Extends the scale above the highest value by this share of the value range: with values from `0` to `1000`, `0.1` ends the axis at `1100` (before rounding to the grid). If not set, a `logarithmic` axis without `strictMinMax` uses `0.2`. Click here for more info
extraMin #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Extends the scale below the lowest value by this share of the value range: with values from `0` to `1000`, `0.1` starts the axis at `-100` (before rounding to the grid). If not set, a `logarithmic` axis without `strictMinMax` uses `0.1`. Click here for more info
extraTooltipPrecision #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Extra decimal places for the axis tooltip, beyond those of the labels: with labels like `1.1` and `1.2`, `1` lets the tooltip show `1.15`. Click here for more info
fillRule #	Type `undefined` \| ( dataItem: `DataItem`) => `void` Inherited from `IValueAxisSettings` Function that decides which axis fills show; it is called for each grid step. The default fills every other step. Click here for more info
fixAxisSize #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IAxisSettings` Keeps the axis from shrinking as zooming changes the visible labels: it keeps room for the widest label shown so far.
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
gridIntervals #	Type `Array` Inherited from `IDateAxisSettings` Intervals the grid and labels can be placed at, from shortest to longest. The axis uses the shortest that keeps grid lines at least `minGridDistance` apart. Click here for more info
groupCount #	Type `undefined` \| `number` Default `500` Inherited from `IDateAxisSettings` Most data items to show at once before `groupData` groups them into a longer interval. Click here for more info
groupData #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IDateAxisSettings` Groups data items into longer intervals from `groupIntervals` whenever more than `groupCount` of them would be in view, and back as the chart zooms in. Click here for more info
groupInterval #	Type `ITimeInterval` Inherited from `IDateAxisSettings` Groups data into this interval at any zoom, when `groupData` is on. It must be one of `groupIntervals`. Click here for more info
groupIntervals #	Type `Array` Inherited from `IDateAxisSettings` Intervals `groupData` can group data into, from shortest to longest. 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.
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.
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
logarithmic #	Type `undefined` \| `false` \| `true` Inherited from `IValueAxisSettings` Uses a logarithmic scale. It can show only values above zero; see `treatZeroAs`. Click here for more info
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.
markUnitChange #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IDateAxisSettings` Formats labels where a new period begins, such as the first day of a month, with `periodChangeDateFormats` instead of `dateFormats`.
mask #	Type `Graphics` \| `null` Inherited from `IContainerSettings` An element whose shape clips the container's children. Click here for more info
maskContent #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` Clips all content that goes outside the container's bounds.
max #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Highest value of the axis scale, instead of the highest series value. The axis may round it to fit its grid, unless `strictMinMax` is `true`. Click here for more info
maxDeviation #	Type `undefined` \| `number` Default `0.1` Inherited from `IAxisSettings` How far past its ends the axis can be zoomed or panned, as a share of the visible range: `0.1` is 10%. Click here for more info
maxHeight #	Type `number` \| `null` Inherited from `ISpriteSettings` Maximum allowed height in pixels.
maxPrecision #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Most decimal places the labels may have. It also limits the grid step: `0` allows whole-number steps only. Click here for more info
maxWidth #	Type `number` \| `null` Inherited from `ISpriteSettings` Maximum allowed width in pixels.
maxZoomCount #	Type `undefined` \| `number` Inherited from `IAxisSettings` Most cells to show at a time, such as categories on a `CategoryAxis` or `baseInterval` periods on a `DateAxis`. The axis can't be zoomed out any further. Click here for more info
maxZoomFactor #	Type `number` \| `null` Default `1000` Inherited from `IAxisSettings` Roughly how many times the axis can be zoomed in. A `CategoryAxis` ignores it and zooms in as far as `minZoomCount` categories; a `DateAxis` set to `null` (its default) zooms in as far as `minZoomCount` base intervals.
min #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Lowest value of the axis scale, instead of the lowest series value. The axis may round it to fit its grid, unless `strictMinMax` is `true`. 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.
minZoomCount #	Type `undefined` \| `number` Inherited from `IAxisSettings` Fewest cells to show at a time, such as categories on a `CategoryAxis` or `baseInterval` periods on a `DateAxis`. The axis can't be zoomed in any further. Click here for more info
minorAxisFillsEnabled #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` Creates axis fills for the cells of the minor grid too, not only the main one. The `fillRule` still decides which of them show. @since 5.14.0
minorDateFormats #	Type `undefined` \| `object` Inherited from `IDateAxisSettings` Date formats for minor grid labels, by time unit. If not set, `dateFormats` is used. Click here for more info @since 5.6.0
numberFormat #	Type `undefined` \| `string` Inherited from `IValueAxisSettings` Number format for the labels. If not set, the number formatter's default format is used, with as many decimals as the grid step needs. Click here for more info
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).
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.
panX #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` `false` keeps this axis in place when the chart is panned horizontally, by dragging or with the mouse wheel. Click here for more info
panY #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` `false` keeps this axis in place when the chart is panned vertically, by dragging or with the mouse wheel. Click here for more info
periodChangeDateFormats #	Type `undefined` \| `object` Inherited from `IDateAxisSettings` Date formats, by time unit, for labels where a new period begins (see `markUnitChange`). Click here for more info
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.
renderer #	Type `R` Inherited from `IAxisSettings` The renderer that draws the axis line, labels, ticks, grid and fills: `AxisRendererX` for a horizontal axis, `AxisRendererY` for a vertical one. Click here for more info
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
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
skipFirstMinor #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IDateAxisSettings` Skips the minor grid line and label that would fall on each main grid line. @since 5.14.0
snapTooltip #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IAxisSettings` Snaps the tooltip to `tooltipLocation` in the cell under the cursor, instead of following the cursor exactly.
start #	Type `undefined` \| `number` Default `0` Inherited from `IAxisSettings` Start of the visible (zoomed) part of the axis: `0` is the start of the axis, `1` the end. Set it to pre-zoom: `0.1` hides the first 10%. Click here for more info
startLocation #	Type `undefined` \| `number` Default `0` Inherited from `IDateAxisSettings` Where within the first period the axis starts, from `0` (its start) to `1` (its end): `0.5` cuts off the first half of the first period.
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.
strictMinMax #	Type `undefined` \| `false` \| `true` Inherited from `IValueAxisSettings` Makes the scale start and end exactly at `min` and `max`, or where they aren't set, at the lowest and highest series values, without rounding. The axis then also stops rescaling to the values in view as the chart zooms. To rescale to the exact values in view, use `strictMinMaxSelection` instead. `extraMin` and `extraMax` still add padding. Click here for more info
strictMinMaxSelection #	Type `undefined` \| `false` \| `true` Inherited from `IValueAxisSettings` Rescales the axis to exactly the lowest and highest values in view as the chart zooms, without rounding. Keeps series of derived values, such as `valueYChangeSelection`, from jumping around. Has no effect with `strictMinMax`, which stops the rescaling. `extraMin` and `extraMax` still add padding. @since 5.1.11
syncWithAxis #	Type `ValueAxis` Inherited from `IValueAxisSettings` Another `ValueAxis` whose grid this axis lines up with, by adjusting its own scale. A perfect match isn't always possible. Click here for more info
syncZeros #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IValueAxisSettings` Lines up this axis's zero with the zero of `syncWithAxis`, spreading the other grid lines above and below it. Needs zero within the range of `syncWithAxis`, which has to extend to each side where this axis has values. Click here for more info @since 5.16.2
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 `IAxisSettings` Tooltip that shows the axis value at the cursor's position.
tooltipDateFormat #	Type `string` \| `DateTimeFormatOptions` Inherited from `IDateAxisSettings` Date format for the axis tooltip. Overrides `tooltipDateFormats`. Click here for more info
tooltipDateFormats #	Type `undefined` \| `object` Inherited from `IDateAxisSettings` Date formats for the axis tooltip, by the time unit of the current base interval (the group interval while data is grouped). Click here for more info @since 5.1.4
tooltipHTML #	Type `undefined` \| `string` Inherited from `ISpriteSettings` HTML content of the element's tooltip, shown in place of `tooltipText`. @since 5.2.11
tooltipIntervalOffset #	Type `undefined` \| `number` Inherited from `IDateAxisSettings` Shifts the date the axis tooltip shows, in base intervals, from `-1` to `1`. If not set, it is minus `tooltipLocation` (`-0.5` by default), so a tooltip pointing at the middle of a period shows the period's start. Click here for more info @since 5.1.4
tooltipLocation #	Type `undefined` \| `number` Default `0.5` Inherited from `IAxisSettings` Where within a cell the tooltip snaps to when `snapTooltip` is on: `0` the cell's start, `0.5` its middle, `1` its end.
tooltipNumberFormat #	Type `string` \| `NumberFormatOptions` Inherited from `IValueAxisSettings` Number format for the axis tooltip. If not set, `numberFormat` is used. Click here for more info
tooltipPosition #	Type `"fixed"` \| `"pointer"` Default `"fixed"` Inherited from `ISpriteSettings` Where the tooltip points: `"fixed"` at `tooltipX` and `tooltipY`, or `"pointer"` at the pointer, following it.
tooltipText #	Type `undefined` \| `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.
treatZeroAs #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` On a `logarithmic` axis, the value to plot zero and negative values at, since the scale can't show them. Click here for more info
userData #	Type `any` Inherited from `IEntitySettings` Any data of your own to keep with the element.
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.
weekLabelLocation #	Type `undefined` \| `number` Default `0` Inherited from `IDateAxisSettings` Where labels sit within their cell, from `0` (start) to `1` (end), when the grid is in weeks. Replaces the labels' `location` then. @since 5.14.0
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.
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.
zoomOut #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IAxisSettings` `false` leaves the axis out of the chart's zoom-out: the zoom-out button doesn't reset it, and zooming it doesn't show the button. @since 5.14.0
zoomX #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` `false` keeps this axis as it is when the mouse wheel zooms the chart horizontally. The cursor, scrollbars and pinch still zoom it; use `zoomable` to stop those too. Click here for more info
zoomY #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` `false` keeps this axis as it is when the mouse wheel zooms the chart vertically. The cursor, scrollbars and pinch still zoom it; use `zoomable` to stop those too. Click here for more info
zoomable #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` `false` makes `zoom()` do nothing, so the cursor, scrollbars, pinch and mouse wheel can't zoom or scroll the axis. Dragging the plot area still pans it.
There are 152 inherited items currently hidden from this list.

active
#

Type undefined | false | true

Inherited from ISpriteSettings

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

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

autoZoom
#

Type undefined | false | true

Default true

Inherited from IValueAxisSettings

Rescales the axis to fit the values in view as the chart zooms along the other axis. Works only when that axis is not a plain ValueAxis: a DateAxis or a CategoryAxis, for example.

@since 5.2.20

background
#

Type Graphics

Inherited from IContainerSettings

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

Click here for more info

baseInterval
#

Type ITimeInterval

Inherited from IDateAxisSettings

The time interval of the data, such as { timeUnit: "day", count: 1 } for daily data. Each data item takes up one such period on the axis.

Click here for more info

baseValue
#

Type undefined | number

Default 0

Inherited from IValueAxisSettings

The value columns grow from, splitting "positive" from "negative" values. Its grid line gets the "base" theme tag.

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

bullet
#

Type undefined | ( root: Root, axis: Axis, dataItem: DataItem) => AxisBullet

Inherited from IAxisSettings

Function that creates an AxisBullet for each of the axis's cells, such as each category. Axis ranges get none.

Click here for more info

calculateTotals
#

Type undefined | false | true

Inherited from IValueAxisSettings

Calculates totals across the axis's series for each data item in view:

valueYTotal, valueYSum and valueYTotalPercent (or the valueX ones on an X axis), as used by 100% stacked charts. Series with excludeFromTotal are left out.

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

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

dateFormats
#

Type undefined | object

Inherited from IDateAxisSettings

Date formats for labels, by the time unit of the grid, such as "day".

Click here for more info

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.

end
#

Type undefined | number

Default 1

Inherited from IAxisSettings

End of the visible (zoomed) part of the axis: 0 is the start of the axis, 1 the end. Set it to pre-zoom: 0.9 hides the last 10%.

Click here for more info

endLocation
#

Type undefined | number

Default 1

Inherited from IDateAxisSettings

Where within the last period the axis ends, from 0 (its start) to 1 (its end): 0.5 cuts off the second half of the last period.

exportable
#

Type undefined | false | true

Inherited from ISpriteSettings

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

extraMax
#

Type undefined | number

Inherited from IValueAxisSettings

Extends the scale above the highest value by this share of the value range: with values from 0 to 1000, 0.1 ends the axis at 1100 (before rounding to the grid). If not set, a logarithmic axis without strictMinMax uses 0.2.

Click here for more info

extraMin
#

Type undefined | number

Inherited from IValueAxisSettings

Extends the scale below the lowest value by this share of the value range: with values from 0 to 1000, 0.1 starts the axis at -100 (before rounding to the grid). If not set, a logarithmic axis without strictMinMax uses 0.1.

Click here for more info

extraTooltipPrecision
#

Type undefined | number

Inherited from IValueAxisSettings

Extra decimal places for the axis tooltip, beyond those of the labels:

with labels like 1.1 and 1.2, 1 lets the tooltip show 1.15.

Click here for more info

fillRule
#

Type undefined | ( dataItem: DataItem) => void

Inherited from IValueAxisSettings

Function that decides which axis fills show; it is called for each grid step. The default fills every other step.

Click here for more info

fixAxisSize
#

Type undefined | false | true

Default true

Inherited from IAxisSettings

Keeps the axis from shrinking as zooming changes the visible labels: it keeps room for the widest label shown so far.

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

gridIntervals
#

Type Array

Inherited from IDateAxisSettings

Intervals the grid and labels can be placed at, from shortest to longest. The axis uses the shortest that keeps grid lines at least minGridDistance apart.

Click here for more info

groupCount
#

Type undefined | number

Default 500

Inherited from IDateAxisSettings

Most data items to show at once before groupData groups them into a longer interval.

Click here for more info

groupData
#

Type undefined | false | true

Default false

Inherited from IDateAxisSettings

Groups data items into longer intervals from groupIntervals whenever more than groupCount of them would be in view, and back as the chart zooms in.

Click here for more info

groupInterval
#

Type ITimeInterval

Inherited from IDateAxisSettings

Groups data into this interval at any zoom, when groupData is on. It must be one of groupIntervals.

Click here for more info

groupIntervals
#

Type Array

Inherited from IDateAxisSettings

Intervals groupData can group data into, from shortest to longest.

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.

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.

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

logarithmic
#

Type undefined | false | true

Inherited from IValueAxisSettings

Uses a logarithmic scale. It can show only values above zero; see treatZeroAs.

Click here for more info

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.

markUnitChange
#

Type undefined | false | true

Default true

Inherited from IDateAxisSettings

Formats labels where a new period begins, such as the first day of a month, with periodChangeDateFormats instead of dateFormats.

mask
#

Type Graphics | null

Inherited from IContainerSettings

An element whose shape clips the container's children.

Click here for more info

maskContent
#

Type undefined | false | true

Inherited from IContainerSettings

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

max
#

Type undefined | number

Inherited from IValueAxisSettings

Highest value of the axis scale, instead of the highest series value.

The axis may round it to fit its grid, unless strictMinMax is true.

Click here for more info

maxDeviation
#

Type undefined | number

Default 0.1

Inherited from IAxisSettings

How far past its ends the axis can be zoomed or panned, as a share of the visible range: 0.1 is 10%.

Click here for more info

maxHeight
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed height in pixels.

maxPrecision
#

Type undefined | number

Inherited from IValueAxisSettings

Most decimal places the labels may have. It also limits the grid step:

0 allows whole-number steps only.

Click here for more info

maxWidth
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed width in pixels.

maxZoomCount
#

Type undefined | number

Inherited from IAxisSettings

Most cells to show at a time, such as categories on a CategoryAxis or baseInterval periods on a DateAxis. The axis can't be zoomed out any further.

Click here for more info

maxZoomFactor
#

Type number | null

Default 1000

Inherited from IAxisSettings

Roughly how many times the axis can be zoomed in. A CategoryAxis ignores it and zooms in as far as minZoomCount categories; a DateAxis set to null (its default) zooms in as far as minZoomCount base intervals.

min
#

Type undefined | number

Inherited from IValueAxisSettings

Lowest value of the axis scale, instead of the lowest series value. The axis may round it to fit its grid, unless strictMinMax is true.

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.

minZoomCount
#

Type undefined | number

Inherited from IAxisSettings

Fewest cells to show at a time, such as categories on a CategoryAxis or baseInterval periods on a DateAxis. The axis can't be zoomed in any further.

Click here for more info

minorAxisFillsEnabled
#

Type undefined | false | true

Inherited from IAxisSettings

Creates axis fills for the cells of the minor grid too, not only the main one. The fillRule still decides which of them show.

@since 5.14.0

minorDateFormats
#

Type undefined | object

Inherited from IDateAxisSettings

Date formats for minor grid labels, by time unit. If not set, dateFormats is used.

Click here for more info
@since 5.6.0

numberFormat
#

Type undefined | string

Inherited from IValueAxisSettings

Number format for the labels. If not set, the number formatter's default format is used, with as many decimals as the grid step needs.

Click here for more info

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

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.

panX
#

Type undefined | false | true

Inherited from IAxisSettings

false keeps this axis in place when the chart is panned horizontally, by dragging or with the mouse wheel.

Click here for more info

panY
#

Type undefined | false | true

Inherited from IAxisSettings

false keeps this axis in place when the chart is panned vertically, by dragging or with the mouse wheel.

Click here for more info

periodChangeDateFormats
#

Type undefined | object

Inherited from IDateAxisSettings

Date formats, by time unit, for labels where a new period begins (see markUnitChange).

Click here for more info

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.

renderer
#

Type R

Inherited from IAxisSettings

The renderer that draws the axis line, labels, ticks, grid and fills:

AxisRendererX for a horizontal axis, AxisRendererY for a vertical one.

Click here for more info

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

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

skipFirstMinor
#

Type undefined | false | true

Default true

Inherited from IDateAxisSettings

Skips the minor grid line and label that would fall on each main grid line.

@since 5.14.0

snapTooltip
#

Type undefined | false | true

Default true

Inherited from IAxisSettings

Snaps the tooltip to tooltipLocation in the cell under the cursor, instead of following the cursor exactly.

start
#

Type undefined | number

Default 0

Inherited from IAxisSettings

Start of the visible (zoomed) part of the axis: 0 is the start of the axis, 1 the end. Set it to pre-zoom: 0.1 hides the first 10%.

Click here for more info

startLocation
#

Type undefined | number

Default 0

Inherited from IDateAxisSettings

Where within the first period the axis starts, from 0 (its start) to 1 (its end): 0.5 cuts off the first half of the first period.

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.

strictMinMax
#

Type undefined | false | true

Inherited from IValueAxisSettings

Makes the scale start and end exactly at min and max, or where they aren't set, at the lowest and highest series values, without rounding.

The axis then also stops rescaling to the values in view as the chart zooms. To rescale to the exact values in view, use strictMinMaxSelection instead.

extraMin and extraMax still add padding.

Click here for more info

strictMinMaxSelection
#

Type undefined | false | true

Inherited from IValueAxisSettings

Rescales the axis to exactly the lowest and highest values in view as the chart zooms, without rounding. Keeps series of derived values, such as valueYChangeSelection, from jumping around.

Has no effect with strictMinMax, which stops the rescaling. extraMin and extraMax still add padding.

@since 5.1.11

syncWithAxis
#

Type ValueAxis

Inherited from IValueAxisSettings

Another ValueAxis whose grid this axis lines up with, by adjusting its own scale. A perfect match isn't always possible.

Click here for more info

syncZeros
#

Type undefined | false | true

Default false

Inherited from IValueAxisSettings

Lines up this axis's zero with the zero of syncWithAxis, spreading the other grid lines above and below it. Needs zero within the range of syncWithAxis, which has to extend to each side where this axis has values.

Click here for more info
@since 5.16.2

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.

Type Tooltip

Inherited from IAxisSettings

Tooltip that shows the axis value at the cursor's position.

tooltipDateFormat
#

Type string | DateTimeFormatOptions

Inherited from IDateAxisSettings

Date format for the axis tooltip. Overrides tooltipDateFormats.

Click here for more info

tooltipDateFormats
#

Type undefined | object

Inherited from IDateAxisSettings

Date formats for the axis tooltip, by the time unit of the current base interval (the group interval while data is grouped).

Click here for more info
@since 5.1.4

tooltipHTML
#

Type undefined | string

Inherited from ISpriteSettings

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

@since 5.2.11

tooltipIntervalOffset
#

Type undefined | number

Inherited from IDateAxisSettings

Shifts the date the axis tooltip shows, in base intervals, from -1 to 1. If not set, it is minus tooltipLocation (-0.5 by default), so a tooltip pointing at the middle of a period shows the period's start.

Click here for more info
@since 5.1.4

tooltipLocation
#

Type undefined | number

Default 0.5

Inherited from IAxisSettings

Where within a cell the tooltip snaps to when snapTooltip is on: 0 the cell's start, 0.5 its middle, 1 its end.

tooltipNumberFormat
#

Type string | NumberFormatOptions

Inherited from IValueAxisSettings

Number format for the axis tooltip. If not set, numberFormat is used.

Click here for more info

tooltipPosition
#

Type "fixed" | "pointer"

Default "fixed"

Inherited from ISpriteSettings

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

tooltipText
#

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

treatZeroAs
#

Type undefined | number

Inherited from IValueAxisSettings

On a logarithmic axis, the value to plot zero and negative values at, since the scale can't show them.

Click here for more info

userData
#

Type any

Inherited from IEntitySettings

Any data of your own to keep with the element.

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.

weekLabelLocation
#

Type undefined | number

Default 0

Inherited from IDateAxisSettings

Where labels sit within their cell, from 0 (start) to 1 (end), when the grid is in weeks. Replaces the labels' location then.

@since 5.14.0

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.

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.

zoomOut
#

Type undefined | false | true

Default true

Inherited from IAxisSettings

false leaves the axis out of the chart's zoom-out: the zoom-out button doesn't reset it, and zooming it doesn't show the button.

@since 5.14.0

zoomX
#

Type undefined | false | true

Inherited from IAxisSettings

false keeps this axis as it is when the mouse wheel zooms the chart horizontally. The cursor, scrollbars and pinch still zoom it; use zoomable to stop those too.

Click here for more info

zoomY
#

Type undefined | false | true

Inherited from IAxisSettings

false keeps this axis as it is when the mouse wheel zooms the chart vertically. The cursor, scrollbars and pinch still zoom it; use zoomable to stop those too.

Click here for more info

zoomable
#

Type undefined | false | true

Inherited from IAxisSettings

false makes zoom() do nothing, so the cursor, scrollbars, pinch and mouse wheel can't zoom or scroll the axis. Dragging the plot area still pans it.

Inheritance

Properties