CategoryDateAxis – amCharts 5 Documentation

Type class

Category-based date axis.

Data item

CategoryDateAxis uses data items of type ICategoryDateAxisDataItem.

Sources

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

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

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

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

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

Inheritance

CategoryDateAxis extends CategoryAxis.

CategoryDateAxis is not extended by any other symbol.

Settings

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

Read about settings concept.

active #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Indicates if element is currently active.
background #	Type `Graphics` Inherited from `IContainerSettings` Background element. Click here for more info
baseInterval #	Type `ITimeInterval` Indicates granularity of data. Click here for more info
baseValue #	Type `undefined` \| `number` Inherited from `IAxisSettings` Base value of the axis.
blur #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Apply blur filter. Ranges of values in pixels: `0` to `X`. 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` Modifty visual brightness. Range of values: `0` to `1`. 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` A function that will be used to create bullets on each cell. Click here for more info
categoryField #	Type `string` Inherited from `ICategoryAxisSettings` A field in data which holds categories.
centerX #	Type `number` \| `Percent` Inherited from `ISpriteSettings` X coordinate of the center of the element relative to itself. Center coordinates will affect placement as well as rotation pivot point.
centerY #	Type `number` \| `Percent` Inherited from `ISpriteSettings` Y coordinate of the center of the element relative to itself. Center coordinates will affect placement as well as rotation pivot point.
contrast #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Modify contrast. Range of values: `0` to `1`. 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` If set to `true`, an element will try to draw itself in such way, that it looks crisp on screen, with minimal anti-aliasing. It will round x/y position so it is positioned fine "on pixel". It will also adjust `strokeWidth` based on device pixel ratio or zoom, so the line might look thinner than expected. NOTE: this is might not universally work, especially when set on several objects that are supposed to fit perfectly with each other. @since 5.3.0
cursorOverStyle #	Type `undefined` \| `string` Inherited from `ISpriteSettings` A named mouse cursor style to show when hovering this element. Click here for more info
dateFormats #	Type `undefined` \| `object` Date formats used for intermediate labels. Click here for more info
dateFormatter #	Type `DateFormatter` \| `undefined` Inherited from `ISpriteSettings` An instance of `DateFormatter` that should be used instead of global formatter object. Click here for more info
disabled #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Indicates if element is disabled.
draggable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `true`, user will be able to drag this element. It will also disable default drag events over the area of this element.
durationFormatter #	Type `DurationFormatter` \| `undefined` Inherited from `ISpriteSettings` An instance of `DurationFormatter` that should be used instead of global formatter object. 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` Inherited from `IAxisSettings` The initial relative zoom end position of the axis. E.g. stting it to `0.9` will pre-zoom axis to 10% from the end. Click here for more info
endLocation #	Type `undefined` \| `number` Default `1` Inherited from `ICategoryAxisSettings` Relative location of where axis cell ends: 0 - beginning, 1 - end.
exportable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `false` this element will not appear in exported snapshots of the chart.
fillRule #	Type `undefined` \| ( dataItem: `DataItem`, index: `undefined` \| `number`) => `void` Inherited from `ICategoryAxisSettings` A function that can be used to specify how to configure axis fills. Click here for more info
fixAxisSize #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IAxisSettings` If set to `true` (default) the axis width will stay constant across all zooms, even if actual length of all visible labels changes.
forceHidden #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `true` the element will be hidden regardless of `visible` or even if `show()` is called.
forceInactive #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `true` the element will be inactive - absolutely oblivious to all interactions, even if there are related events set, or the `interactive: true` is set. @since 5.0.21
gridIntervals #	Type `Array` A list of intervals the axis is allowed to show grid/labels on. Click here for more info
height #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` Element's absolute height in pixels (numeric value) or relative height to parent (`Percent`);
html #	Type `undefined` \| `string` Inherited from `IContainerSettings` HTML content of the container. Click here for more info @since 5.2.11
hue #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Rotate HUE colors in degrees. Range of values: `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 custom string ID for the element. If set, element can be looked up via `am5.registry.entitiesById`. Will raise error if an element with the same ID already exists.
interactive #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Should this element accept user interaction events?
interactiveChildren #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` If set to `true` all descendants - not just direct children, but every element in it - will become "interactive".
interpolationDuration #	Type `undefined` \| `number` Inherited from `IComponentSettings` A duration of the animation from one setting value to another, in milliseconds. Click here for more info
interpolationEasing #	Type `$ease.Easing` Inherited from `IComponentSettings` Easing function to use for cross setting value animations. Click here for more info
invert #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Invert colors. Range of values: `0` (no changes) to `1` (completely 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` Inherited from `ISpriteSettings` If set to `false` element will not be measured and cannot participate in layout schemes.
layer #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Numeric layer to put element in. Elements with higher number will appear in front of the ones with lower numer. If not set, will inherit layer from its ascendants.
layerMargin #	Type `IMargin` Inherited from `ISpriteSettings` Margins for the layer. Can be used to make the layer larger/or smaller than default chart size. @since @5.2.39
layout #	Type `Layout` \| `null` Inherited from `IContainerSettings` A method to layout 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` Display "period change" labels using different format. If set to `true`, will use `periodChangeDateFormats` instead of `dateFormats` for such labels, e.g. for month start.
mask #	Type `Graphics` \| `null` Inherited from `IContainerSettings` An element to use as a container's mask (clipping region). Click here for more info
maskContent #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` If set to `true` all content going outside the bounds of the container will be clipped.
maxDeviation #	Type `undefined` \| `number` Default `0.1` Inherited from `IAxisSettings` A relative distance the axis is allowed to be zoomed/panned beyond its actual scope. Click here for more info
maxHeight #	Type `number` \| `null` Inherited from `ISpriteSettings` Maximum allowed height in pixels.
maxWidth #	Type `number` \| `null` Inherited from `ISpriteSettings` Maximum allowed width in pixels.
maxZoomCount #	Type `undefined` \| `number` Inherited from `IAxisSettings` Maximum number of axis elements to show at a time. E.g. for a `CategoryAxis` that would be number of categories. For a `DateAxis` it would be number of `baseInterval`. The axis will not allow to be zoomed out beyond this number. Click here for more info
maxZoomFactor #	Type `number` \| `null` Default `1000` Inherited from `IAxisSettings` Maximum number of times the scope of the axis could auto-zoom-in. This is to prevent axis jumping too drastically when scrolling/zooming.
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` Minimum number of axis elements to show at a time. E.g. for a `CategoryAxis` that would be number of categories. For a `DateAxis` it would be number of `baseInterval`. The axis will not allow to be zoomed in beyond this number. Click here for more info
numberFormatter #	Type `NumberFormatter` \| `undefined` Inherited from `ISpriteSettings` An instance of `NumberFormatter` that should be used instead of global formatter object. Click here for more info
opacity #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Opacity. 0 - fully transparent; 1 - fully 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` If set to `false` the axis will be exempt when chart is panned horizontally, and will keep its current position.` Click here for more info
panY #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` If set to `false` the axis will be exempt when chart is panned vertically, and will keep its current position.` Click here for more info
periodChangeDateFormats #	Type `undefined` \| `object` Date formats used for "period change" labels. Click here for more info
position #	Type `"absolute"` \| `"relative"` Inherited from `ISpriteSettings` Positioning of the element. `"absolute"` means element will not participate in parent layout scheme, and will be positioned solely accoridng its `x` and `y` settings.
renderer #	Type `R` Inherited from `IAxisSettings` A renderer object which is responsible of rendering visible axis elements. Click here for more info
reverseChildren #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` If set to `true` its children will be laid out in opposite order. @since 5.1.1
rotation #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Rotation in degrees.
saturate #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Modify saturation. Range of values in pixels: `0` to `X`. `0` - grayscale `1` - no changes `>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` Inherited from `ISpriteSettings` Scale. Setting to a value less than 1 will shrink object.
sepia #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Apply sepia filter. Range of values: `0` (no changes) to `1` (complete sepia). IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
setStateOnChildren #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` If set to `true`, applying a state on a container will also apply the same state on its children. Click here for more info
showTooltipOn #	Type `"hover"` \| `"always"` \| `"click"` Default `"hover"` Inherited from `ISpriteSettings` Defines when tooltip is shown over the element. Available options: `"hover"` (default) - tooltip is shown when element is hovered by a pointer or touched. It is hidden as soon as element is not hovered anymore, or touch occurs outside it. `"always"` - a tooltip will always be shown over the element, without any interactions. Please note that if you need to show tooltips for multiple elements at the same time, you need to explicitly create a `Tooltip` instance and set element's `tooltip` setting with it. '"click"' - a tooltip will only appear when target element is clicked/tapped. Tooltip will hide when clicking anywhere else on the page. Click here for more info @since 5.0.16
snapTooltip #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IAxisSettings` Should tooltip snap to the `tooltipLocation` (`true`) or follow cursor.
start #	Type `undefined` \| `number` Inherited from `IAxisSettings` The initial relative zoom start position of the axis. E.g. stting it to `0.1` will pre-zoom axis to 10% from the start. Click here for more info
startLocation #	Type `undefined` \| `number` Default `0` Inherited from `ICategoryAxisSettings` Relative location of where axis cell starts: 0 - beginning, 1 - end.
stateAnimationDuration #	Type `undefined` \| `number` Inherited from `IEntitySettings` Duration of transition from one state to another.
stateAnimationEasing #	Type `$ease.Easing` Inherited from `IEntitySettings` Easing of transition from one state to another.
templateField #	Type `undefined` \| `string` Inherited from `ISpriteSettings` Allows binding element's settings to data. Click here for more info
themeTags #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. These tags only apply to this object, not any children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` A list of themes applied to the element.
toggleKey #	Type `"disabled"` \| `"active"` \| `"none"` \| `undefined` Inherited from `ISpriteSettings` If set, element will toggle specified boolean setting between `true` and `false` when clicked/touched.
tooltip #	Type `Tooltip` Inherited from `IAxisSettings` `Tooltip` element to use for axis.
tooltipDateFormat #	Type `undefined` \| `string` A date format to use for axis tooltip. Click here for more info
tooltipHTML #	Type `undefined` \| `string` Inherited from `ISpriteSettings` HTML content to show in a tooltip when hovered. @since 5.2.11
tooltipLocation #	Type `undefined` \| `number` Default `0.5` Inherited from `IAxisSettings` `tooltipLocation` indicates which relative place to snap to: `0` beginning, `0.5` - middle, `1` - end.
tooltipPosition #	Type `"fixed"` \| `"pointer"` Inherited from `ISpriteSettings` Tooltip position.
tooltipText #	Type `undefined` \| `string` Inherited from `ISpriteSettings` Text to show in a tooltip when hovered.
tooltipX #	Type `number` \| `Percent` Inherited from `ISpriteSettings` Tooltip pointer X coordinate relative to the element itself.
tooltipY #	Type `number` \| `Percent` Inherited from `ISpriteSettings` Tooltip pointer Y coordinate relative to the element itself.
userData #	Type `any` Inherited from `IEntitySettings` A storage for any custom user data that needs to be associated with the element.
verticalScrollbar #	Type `Scrollbar` Inherited from `IContainerSettings` Setting this to an instance of `Scrollbar` will enable vertical scrolling of content if it does not fit into the Container. Click here for more info
visible #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Is element visible?
wheelable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `true`, mouse wheel events will be triggered over the element. It will also disable page scrolling using mouse wheel when pointer is over the element.
width #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` Element's absolute width in pixels (numeric value) or relative width to parent (`Percent`);
x #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` X position relative to parent.
y #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` Y position relative to parent.
zoomX #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` If set to `false` the axis will be exempt when chart is zoomed horizontally, and will keep its current zoom/position.` Click here for more info
zoomY #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` If set to `false` the axis will be exempt when chart is zoomed vertically, and will keep its current zoom/position.` Click here for more info
zoomable #	Type `undefined` \| `false` \| `true` Inherited from `IAxisSettings` Set this to `false` to prevent axis from being zoomed.
There are 96 inherited items currently hidden from this list.

Private settings

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

Read about private settings.

baseInterval #	Read only Type `ITimeInterval` Current base interval.
cellWidth #	Read only Type `undefined` \| `number` Inherited from `IAxisPrivate` Width in pixels between grid lines (read-only). It might not be exact, as `DateAxis` can have grids at irregular intervals. Could be used to detect when size changes and to adjust labels for them not to overlap.
endIndex #	Read only Type `undefined` \| `number` Inherited from `ICategoryAxisPrivate` End index of the current zoom scope.
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
htmlElement #	Read only Type `HTMLDivElement` Inherited from `IContainerPrivate` A `<div>` element used for HTML content of the `Container`.
showingTooltip #	Read only Type `undefined` \| `false` \| `true` Inherited from `ISpritePrivate` Is element currently showing a tooltip?
startIndex #	Read only Type `undefined` \| `number` Inherited from `ICategoryAxisPrivate` Start index of the current zoom scope.
tooltipPosition #	Read only Type `undefined` \| `number` Inherited from `IAxisPrivate` Saves position to which tooltip points.
tooltipTarget #	Read only Type `Graphics` Inherited from `ISpritePrivate` An element tooltip should inherit its colors from.
trustBounds #	Read only Type `undefined` \| `false` \| `true` Inherited from `ISpritePrivate` If set to `true`, the sprite will check if a mouse pointer is within its bounds before dispatching pointer events. This helps to solve ghost tooltips problem that sometimes appear while moving the pointer over interactive objects. This is set to `true` by default on `Rectangle` and `Circle`. @since 5.5.0
There are 9 inherited items currently hidden from this list.

Properties

adapters #	Type `Adapters` Default `new Adapters(this)` Inherited from `Entity`
axisHeader #	Type `Container` Default `new Container` Inherited from `Axis` A container above the axis that can be used to add additional stuff into it. For example a legend, label, or an icon. Click here for more info
axisRanges #	Type `List` Default `new List()` Inherited from `Axis` A list of axis ranges. Click here for more info
bulletsContainer #	Type `Container` Default `new Container` Inherited from `Axis` A `Container` that holds all the axis bullet elements.
chart #	Type `XYChart` \| `undefined` Inherited from `Axis` A referenece to the the chart the axis belongs to.
children #	Type `Children` Default `new Children(this)` Inherited from `Container` List of Container's child elements.
className #	Static Type `string` Default `"CategoryDateAxis"`
classNames #	Static Type `Array` Default `"CategoryDateAxis", "CategoryAxis", "Axis", "Component", "Container", "Sprite", "Entity"`
data #	Type `ListData` Inherited from `Component` Component's data. Click here for more info
dataItem #	Type `DataItem` \| `undefined` Inherited from `Sprite` A `DataItem` used for this element. NOTE: data item is being assigned automatically in most cases where it matters. Use this accessor to set data item only if you know what you're doing.
dataItems #	Type `Array` Inherited from `Component` A list of component's data items.
events #	Type `SpriteEventDispatcher` Inherited from `Sprite`
ghostLabel #	Type `AxisLabel` Inherited from `Axis` A control label that is invisible but is used to keep width the width of the axis constant. Click here for more info
gridContainer #	Type `Container` Default `Container.new()` Inherited from `Axis` A `Container` that holds all the axis grid and fill elements.
inited #	Type `boolean` Default `false` Inherited from `Component` Indicates if the component has already been initialized.
labelsContainer #	Type `Container` Default `Container.new()` Inherited from `Axis` A `Container` that holds all the axis label elements.
minorDataItems #	Type `Array` Default `[]` Inherited from `Axis` Array of minor data items.
parent #	Type `Container` \| `undefined` Inherited from `Sprite` Parent `Container` of this element.
root #	Type `Root` Inherited from `Entity` An instance of `Root` object. @readonly @since 5.0.6
series #	Type `Array` Inherited from `Axis` A list of series using this axis.
states #	Type `States` Default `new States(this)` Inherited from `Entity`
template #	Type `Template` \| `undefined` Inherited from `Entity` @todo needs description
topGridContainer #	Type `Container` Default `Container.new()` Inherited from `Axis` A `Container` that holds axis grid elements which goes above the series.
uid #	Type `number` Default `++counter` Inherited from `Settings` Unique ID.
There are 22 inherited items currently hidden from this list.

Methods

allChildren() #	Returns `Array` Inherited from `Container`
animate( options: `AnimationOptions` ) #	Returns `Animation` Inherited from `Settings` Animates setting values from current/start values to new ones. Click here for more info
appear( duration?: `undefined` \| `number`, delay?: `undefined` \| `number` ) #	Returns `Promise` Inherited from `Sprite` Plays initial reveal animation regardless if element is currently hidden or visible.
axisPositionToIndex( position: `number` ) #	Returns `number` Inherited from `CategoryAxis` Returns an index of the category that corresponds to specific pixel position within axis.
baseDuration() #	Returns `number` Returns a duration of currently active `baseInterval` in milliseconds.
categoryToIndex( category: `string` ) #	Returns `number` Inherited from `CategoryAxis` Returns an index of a category.
compositeOpacity() #	Returns `number` Inherited from `Sprite` Returns an actual opacity of the element, taking into account all parents. @since 5.2.11
compositeScale() #	Returns `number` Inherited from `Sprite` Returns an actual scale of the element, taking into account all parents. @since 5.9.2
coordinateToPosition( coordinate: `number` ) #	Returns `number` Inherited from `Axis` Converts pixel coordinate to a relative position on axis.
createAxisRange( axisDataItem: `DataItem` ) #	Returns `DataItem` Inherited from `Axis` Creates and returns an axis range object. Click here for more info
depth() #	Returns `number` Inherited from `Sprite` Returns depth (how deep in the hierachy of the content tree) of this element.
dispose() #	Returns `void` Inherited from `Settings` Disposes this object.
eachChildren( f: ( child: `Sprite`) => `void` ) #	Returns `void` Inherited from `Container`
endIndex() #	Returns `number` Inherited from `CategoryAxis`
get( key: `Key`, fallback: `F` ) #	Returns `NonNullable` \| `F` Inherited from `Entity` Returns settings value for the specified `key`. If there is no value, `fallback` is returned instead (if set). Click here for more info
getCellWidthPosition() #	Returns `number` Inherited from `CategoryAxis` Returns position span between start and end of a single cell in axis. @since 5.2.30
getDateFormatter() #	Returns `DateFormatter` Inherited from `Sprite` Returns an instance of `DateFormatter` used in this element. If this element does not have it set, global one form `Root` is used. Click here for more info
getDurationFormatter() #	Returns `DurationFormatter` Inherited from `Sprite` Returns an instance of `DurationFormatter` used in this element. If this element does not have it set, global one form `Root` is used. Click here for more info
getNumberFormatter() #	Returns `NumberFormatter` Inherited from `Sprite` Returns an instance of `NumberFormatter` used in this element. If this element does not have it set, global one form `Root` is used. Click here for more info
getSeriesItem( series: `XYSeries`, position: `number` ) #	Returns `DataItem` \| `undefined` Inherited from `CategoryAxis` Returns a data item from series that is closest to the `position`.
getTooltip() #	Returns `Tooltip` \| `undefined` Inherited from `Sprite` Returns `Tooltip` used for this element.
getTooltipText( position: `number`, _adjustPosition?: `undefined` \| `false` \| `true` ) #	Returns `string` \| `undefined` Returns text to be used in an axis tooltip for specific relative position.
getX( value: `string` ) #	Returns `number` Inherited from `CategoryAxis` Returns X coordinate in pixels corresponding to specific category index.
getY( value: `string` ) #	Returns `number` Inherited from `CategoryAxis` Returns Y coordinate in pixels corresponding to specific category index.
has( key: `Key` ) #	Returns `boolean` Inherited from `Settings` Returns `true` if the setting exists. Click here for more info
height() #	Returns `number` Inherited from `Sprite` Returns height of this element in pixels.
hide( duration?: `undefined` \| `number` ) #	Returns `Promise` Inherited from `Sprite` Hides the element and returns a `Promise` which completes when all hiding animations are finished. series.hide().then(function(ev) { console.log("Series finished hiding"); }) series.hide().then(function(ev) { console.log("Series finished hiding"); })
hideTooltip() #	Returns `void` Inherited from `Sprite` Hides element's `Tooltip`.
hover() #	Returns `void` Inherited from `Sprite` Simulate hover over element.
indexToPosition( index: `number`, location?: `undefined` \| `number` ) #	Returns `number` Inherited from `CategoryAxis` Converts category index to a relative position. `location` indicates relative position within category: 0 - start, 1 - end. If not set, will use middle (0.5) of the category.
innerHeight() #	Returns `number` Inherited from `Container` Returns container's inner height (height without padding) in pixels.
innerWidth() #	Returns `number` Inherited from `Container` Returns container's inner width (width without padding) in pixels.
isDisposed() #	Returns `boolean` Inherited from `Settings` Returns `true` if this element is disposed.
isDragging() #	Returns `boolean` Inherited from `Sprite` Returns `true` if this element is currently 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 this element is currently hidden.
isHiding() #	Returns `boolean` Inherited from `Sprite` Returns `true` if this element is currently animating to a hidden state.
isHover() #	Returns `boolean` Inherited from `Sprite` Returns `true` if this element is currently hovered by a pointer.
isShowing() #	Returns `boolean` Inherited from `Sprite` Returns `true` if this element is currently animating to a default state.
isType( type: `string` ) #	Returns `this` Inherited from `Entity` Checks if element is of certain class (or inherits one).
isVisible() #	Returns `boolean` Inherited from `Sprite` Returns `false` if if either public or private setting `visible` is set to `false`, or `forceHidden` is set to `true`.
isVisibleDeep() #	Returns `boolean` Inherited from `Sprite` Same as `isVisible()`, except it checks all ascendants, too. @since 5.2.7
markDirtyKey( key: `Key` ) #	Returns `void` Inherited from `Sprite` Marks some setting as dirty. Could be used to trigger adapter.
markDirtyValues( _dataItem?: `DataItem` ) #	Returns `void` Inherited from `Component` Forces a repaint of the element which relies on data. @since 5.0.21
maxHeight() #	Returns `number` Inherited from `Sprite` Returns maximum allowed height of this element in pixels.
maxWidth() #	Returns `number` Inherited from `Sprite` Returns maximum allowed width of this element in pixels.
new( root: `Root`, settings: `ITSettings`, template?: `Template` ) #	Static Returns `T` Inherited from `Entity` Use this method to create an instance of this 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 for when value of a setting changes. Click here for more info @since 5.9.2
offPrivate( key: `Key`, callback?: `undefined` \| ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `void` Inherited from `Settings` Removes a callback for when value of a private setting changes. Click here for more info @since 5.9.2
on( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `IDisposer` Inherited from `Settings` Sets a callback function to invoke when specific key of settings changes or is set. Click here for more info
onPrivate( key: `Key`, callback: ( value: `[""]`, target: `this`, key: `Key`) => `void` ) #	Returns `IDisposer` Inherited from `Settings` Sets a callback function to invoke when specific key of private settings changes or is set. Click here for more info
remove( key: `Key` ) #	Returns `void` Inherited from `Entity` Removes a setting value for the specified `key`. Click here for more info
removeAll() #	Returns `void` Inherited from `Settings` Removes all keys; Click here for more info
set( key: `Key`, value: `Value` ) #	Returns `Value` Inherited from `Entity` Sets a setting `value` for the specified `key`, and returns the same `value`. Click here for more info
setAll( settings: `Partial` ) #	Returns `void` Inherited from `Settings` Sets multiple settings at once. `settings` must be an object with key: value pairs. Click here for more info
setTimeout( fn: () => `void`, delay: `number` ) #	Returns `IDisposer` Inherited from `Entity` Creates and returns a "disposable" timeout.
show( duration?: `undefined` \| `number` ) #	Returns `Promise` Inherited from `Sprite` Shows currently hidden element and returns a `Promise` which completes when all showing animations are finished. series.show().then(function(ev) { console.log("Series is now fully visible"); }) series.show().then(function(ev) { console.log("Series is now fully visible"); })
showTooltip( point?: `IPoint` ) #	Returns `void` Inherited from `Sprite` Shows element's `Tooltip`.
startIndex() #	Returns `number` Inherited from `CategoryAxis`
toAxisPosition( position: `number` ) #	Returns `number` Inherited from `Axis` Converts relative position of the plot area to relative position of the axis with zoom taken into account.
toBack() #	Returns `void` Inherited from `Sprite` Moves sprite to the beginning of the parent's children array. Depending on `layout` setting of the parten container, it may effect the positioning or overlapping order of the elements.
toFront() #	Returns `void` Inherited from `Sprite` Moves sprite to the end of the parent's children array. Depending on `layout` setting of the parten container, it may effect the positioning or overlapping order of the elements.
toGlobal( point: `IPoint` ) #	Returns `IPoint` Inherited from `Sprite` Converts X/Y coordinate within this element to a global coordinate.
toGlobalPosition( position: `number` ) #	Returns `number` Inherited from `Axis` Converts relative position of the axis to a global position taking current zoom into account (opposite to what `toAxisPosition` does). @since 5.4.2
toLocal( point: `IPoint` ) #	Returns `IPoint` Inherited from `Sprite` Converts global X/Y coordinate to a coordinate within this element.
unhover() #	Returns `void` Inherited from `Sprite` Simulate unhover over element.
updateTooltip() #	Returns `void` Inherited from `Axis` Can be called when axis zoom changes and you need to update tooltip position.
width() #	Returns `number` Inherited from `Sprite` Returns width of this element in pixels.
x() #	Returns `number` Inherited from `Sprite` Returns element's actual X position in pixels.
y() #	Returns `number` Inherited from `Sprite` Returns element's actual Y position in pixels.
zoom( start: `number`, end: `number`, duration?: `undefined` \| `number`, priority?: `"start"` \| `"end"` ) #	Returns `Animation` \| `Animation` \| `undefined` Inherited from `Axis` Zooms the axis to relative locations. Both `start` and `end` are relative: 0 means start of the axis, 1 - end.
zoomToCategories( startCategory: `string`, endCategory: `string`, duration?: `undefined` \| `number` ) #	Returns `void` Inherited from `CategoryAxis`
zoomToIndexes( start: `number`, end: `number`, duration?: `undefined` \| `number` ) #	Returns `void` Inherited from `CategoryAxis` Zooms the axis to specific `start` and `end` indexes. Optional `duration` specifies duration of zoom animation in milliseconds.
There are 71 inherited items currently hidden from this list.

allChildren()

Returns Array

Inherited from Container

animate(

options: AnimationOptions

)

Returns Animation

Inherited from Settings

Animates setting values from current/start values to new ones.

Click here for more info

appear(

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

)

Returns Promise

Inherited from Sprite

Plays initial reveal animation regardless if element is currently hidden or visible.

axisPositionToIndex(

position: number

)

Returns number

Inherited from CategoryAxis

Returns an index of the category that corresponds to specific pixel position within axis.

baseDuration()

Returns number

Returns a duration of currently active baseInterval in milliseconds.

categoryToIndex(

category: string

)

Returns number

Inherited from CategoryAxis

Returns an index of a category.

compositeOpacity()

Returns number

Inherited from Sprite

Returns an actual opacity of the element, taking into account all parents.

@since 5.2.11

compositeScale()

Returns number

Inherited from Sprite

Returns an actual scale of the element, taking into account all parents.

@since 5.9.2

coordinateToPosition(

coordinate: number

)

Returns number

Inherited from Axis

Converts pixel coordinate to a relative position on axis.

createAxisRange(

axisDataItem: DataItem

)

Returns DataItem

Inherited from Axis

Creates and returns an axis range object.

Click here for more info

depth()

Returns number

Inherited from Sprite

Returns depth (how deep in the hierachy of the content tree) of this element.

dispose()

Returns void

Inherited from Settings

Disposes this object.

eachChildren(

f: ( child: Sprite) => void

)

Returns void

Inherited from Container

endIndex()

Returns number

Inherited from CategoryAxis

get(

key: Key,
fallback: F

)

Returns NonNullable | F

Inherited from Entity

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

getCellWidthPosition()

Returns number

Inherited from CategoryAxis

Returns position span between start and end of a single cell in axis.

@since 5.2.30

getDateFormatter()

Returns DateFormatter

Inherited from Sprite

Returns an instance of DateFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getDurationFormatter()

Returns DurationFormatter

Inherited from Sprite

Returns an instance of DurationFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getNumberFormatter()

Returns NumberFormatter

Inherited from Sprite

Returns an instance of NumberFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getSeriesItem(

series: XYSeries,
position: number

)

Returns DataItem | undefined

Inherited from CategoryAxis

Returns a data item from series that is closest to the position.

getTooltip()

Returns Tooltip | undefined

Inherited from Sprite

Returns Tooltip used for this element.

getTooltipText(

position: number,
_adjustPosition?: undefined | false | true

)

Returns string | undefined

Returns text to be used in an axis tooltip for specific relative position.

getX(

value: string

)

Returns number

Inherited from CategoryAxis

Returns X coordinate in pixels corresponding to specific category index.

getY(

value: string

)

Returns number

Inherited from CategoryAxis

Returns Y coordinate in pixels corresponding to specific category index.

has(

key: Key

)

Returns boolean

Inherited from Settings

Returns true if the setting exists.

Click here for more info

height()

Returns number

Inherited from Sprite

Returns height of this element in pixels.

hide(

duration?: undefined | number

)

Returns Promise

Inherited from Sprite

Hides the element and returns a Promise which completes when all hiding animations are finished.

series.hide().then(function(ev) {
  console.log("Series finished hiding");
})

series.hide().then(function(ev) {
  console.log("Series finished hiding");
})

hideTooltip()

Returns void

Inherited from Sprite

Hides element's Tooltip.

hover()

Returns void

Inherited from Sprite

Simulate hover over element.

indexToPosition(

index: number,
location?: undefined | number

)

Returns number

Inherited from CategoryAxis

Converts category index to a relative position.

location indicates relative position within category: 0 - start, 1 - end.

If not set, will use middle (0.5) of the category.

innerHeight()

Returns number

Inherited from Container

Returns container's inner height (height without padding) in pixels.

innerWidth()

Returns number

Inherited from Container

Returns container's inner width (width without padding) in pixels.

isDisposed()

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

isDragging()

Returns boolean

Inherited from Sprite

Returns true if this element is currently 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 this element is currently hidden.

isHiding()

Returns boolean

Inherited from Sprite

Returns true if this element is currently animating to a hidden state.

isHover()

Returns boolean

Inherited from Sprite

Returns true if this element is currently hovered by a pointer.

isShowing()

Returns boolean

Inherited from Sprite

Returns true if this element is currently animating to a default state.

isType(

type: string

)

Returns this

Inherited from Entity

Checks if element is of certain class (or inherits one).

isVisible()

Returns boolean

Inherited from Sprite

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

isVisibleDeep()

Returns boolean

Inherited from Sprite

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

@since 5.2.7

markDirtyKey(

key: Key

)

Returns void

Inherited from Sprite

Marks some setting as dirty. Could be used to trigger adapter.

markDirtyValues(

_dataItem?: DataItem

)

Returns void

Inherited from Component

Forces a repaint of the element which relies on data.

@since 5.0.21

maxHeight()

Returns number

Inherited from Sprite

Returns maximum allowed height of this element in pixels.

maxWidth()

Returns number

Inherited from Sprite

Returns maximum allowed width of this element in pixels.

new(

root: Root,
settings: ITSettings,
template?: Template

)

Static

Returns T

Inherited from Entity

Use this method to create an instance of this 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 for when value of a setting changes.

Click here for more info
@since 5.9.2

offPrivate(

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

)

Returns void

Inherited from Settings

Removes a callback for when value of a private setting changes.

Click here for more info
@since 5.9.2

on(

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

)

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

onPrivate(

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

)

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of private settings changes or is set.

Click here for more info

remove(

key: Key

)

Returns void

Inherited from Entity

Removes a setting value for the specified key.

Click here for more info

removeAll()

Returns void

Inherited from Settings

Removes all keys;

Click here for more info

set(

key: Key,
value: Value

)

Returns Value

Inherited from Entity

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

Returns void

Inherited from Settings

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.

show(

duration?: undefined | number

)

Returns Promise

Inherited from Sprite

Shows currently hidden element and returns a Promise which completes when all showing animations are finished.

series.show().then(function(ev) {
  console.log("Series is now fully visible");
})

series.show().then(function(ev) {
  console.log("Series is now fully visible");
})

showTooltip(

point?: IPoint

)

Returns void

Inherited from Sprite

Shows element's Tooltip.

startIndex()

Returns number

Inherited from CategoryAxis

toAxisPosition(

position: number

)

Returns number

Inherited from Axis

Converts relative position of the plot area to relative position of the axis with zoom taken into account.

toBack()

Returns void

Inherited from Sprite

Moves sprite to the beginning of the parent's children array.

Depending on layout setting of the parten container, it may effect the positioning or overlapping order of the elements.

toFront()

Returns void

Inherited from Sprite

Moves sprite to the end of the parent's children array.

Depending on layout setting of the parten container, it may effect the positioning or overlapping order of the elements.

toGlobal(

point: IPoint

)

Returns IPoint

Inherited from Sprite

Converts X/Y coordinate within this element to a global coordinate.

toGlobalPosition(

position: number

)

Returns number

Inherited from Axis

Converts relative position of the axis to a global position taking current zoom into account (opposite to what toAxisPosition does).

@since 5.4.2

toLocal(

point: IPoint

)

Returns IPoint

Inherited from Sprite

Converts global X/Y coordinate to a coordinate within this element.

unhover()

Returns void

Inherited from Sprite

Simulate unhover over element.

updateTooltip()

Returns void

Inherited from Axis

Can be called when axis zoom changes and you need to update tooltip position.

width()

Returns number

Inherited from Sprite

Returns width of this element in pixels.

x()

Returns number

Inherited from Sprite

Returns element's actual X position in pixels.

y()

Returns number

Inherited from Sprite

Returns element's actual Y position in pixels.

zoom(

start: number,
end: number,
duration?: undefined | number,
priority?: "start" | "end"

)

Returns Animation | Animation | undefined

Inherited from Axis

Zooms the axis to relative locations.

Both start and end are relative: 0 means start of the axis, 1 - end.

zoomToCategories(

startCategory: string,
endCategory: string,
duration?: undefined | number

)

Returns void

Inherited from CategoryAxis

zoomToIndexes(

start: number,
end: number,
duration?: undefined | number

)

Returns void

Inherited from CategoryAxis

Zooms the axis to specific start and end indexes.

Optional duration specifies duration of zoom animation in milliseconds.

There are 71 inherited items currently hidden from this list.

Events

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

Read about adding event handlers.

#blur	Param { originalEvent: `FocusEvent`, target: `Sprite`, type: `"blur"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element loses focus.
#boundschanged	Param { type: `"boundschanged"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element's bounds change due to any manipulation to it.
#click	Param { type: `"click"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element is clicked or tapped.
#dataitemchanged	Param { newDataItem: `DataItem` \| `undefined`, oldDataItem: `DataItem` \| `undefined`, type: `"dataitemchanged"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element's data item changes.
#datavalidated	Param { type: `"datavalidated"`, target: `this` } Inherited from `IComponentEvents`
#dblclick	Param { type: `"dblclick"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element is doubleclicked or tapped twice quickly.
#dragged	Param { type: `"dragged"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element ois being dragged.
#dragstart	Param { type: `"dragstart"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element dragging starts.
#dragstop	Param { type: `"dragstop"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element dragging stops.
#focus	Param { originalEvent: `FocusEvent`, target: `Sprite`, type: `"focus"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element gains focus.
#globalpointermove	Param { type: `"globalpointermove"`, target: `this` } Inherited from `ISpriteEvents` Invoked when pointer is moving anywhere in the window, even outside of the element or even chart area.
#globalpointerup	Param { type: `"globalpointerup"`, target: `this` } Inherited from `ISpriteEvents` Invoked when pointer button is released or touch stops in the window, even outside of the element or even chart area.
#middleclick	Param { type: `"middleclick"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element is clicked with the middle mouse button.
#pointerdown	Param { type: `"pointerdown"`, target: `this` } Inherited from `ISpriteEvents` Invoked when pointer button is pressed or touch starts over the element.
#pointerout	Param { type: `"pointerout"`, target: `this` } Inherited from `ISpriteEvents` Invoked when pointer moves outside the element.
#pointerover	Param { type: `"pointerover"`, target: `this` } Inherited from `ISpriteEvents` Invoked when pointer moves over the element.
#pointerup	Param { type: `"pointerup"`, target: `this` } Inherited from `ISpriteEvents` Invoked when pointer button is released or touch stops over the element.
#positionchanged	Param { type: `"positionchanged"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element's position (X/Y) changes.
#rightclick	Param { type: `"rightclick"`, target: `this` } Inherited from `ISpriteEvents` Invoked when element is clicked width the right mouse button.
#wheel	Param { originalEvent: `WheelEvent`, point: `IPoint`, type: `"wheel"`, target: `this` } Inherited from `ISpriteEvents` Invoked when mouse wheel is spinned while pointer is over the element.
There are 20 inherited items currently hidden from this list.