IDateAxisSettings – amCharts 5 Documentation

Type interface

Inheritance

IDateAxisSettings extends IValueAxisSettings.

IDateAxisSettings is extended by IGaplessDateAxisSettings.

Properties

active #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Indicates if element is currently active.
autoZoom #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IValueAxisSettings` If set to `false`, the axis won't be auto-zoomed to a selection (this works only if the other axis is a `DateAxis` or a `CategoryAxis`). IMPORTANT: This setting will be ignored if both X and Y axes are a `ValueAxis`. @since 5.2.20
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` Default `0` Inherited from `IValueAxisSettings` Base value, which indicates the threshold between "positive" and "negative" values. Click here for more info
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
calculateTotals #	Type `undefined` \| `false` \| `true` Inherited from `IValueAxisSettings` If your series relies on dynamically calculated values, like value changes, percents, or total sums, set this to `true`. Click here for more info
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.
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` Relative location of where axis cell ends: 0 - beginning, 1 - end. IMPORTANT: `endLocation` is not supported by `GaplessDateAxis`.
exportable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `false` this element will not appear in exported snapshots of the chart.
extraMax #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Relative extension to the automatically-calculated maximum value of the axis scale. E..g. `0.1` will extend the scale by 10%, so if max value is `1000`, the axis will now show maximum value of `1100`. Click here for more info
extraMin #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Relative extension to the automatically-calculated minimum value of the axis scale. E..g. `0.1` will extend the scale by 10%, so if max value is `1000` and minimum value is `0`, the new minimum value will be `-100`. Click here for more info
extraTooltipPrecision #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` If set, will use greater precision for the axis fooltip than the one for axis' actual labels. E.g. if axis displays labels with one decimal (`1.0`, `1.1`, `1.2`) setting this setting to `1` would allow two decimals in axis tooltip, e.g. `1.15`. Click here for more info
fillRule #	Type `undefined` \| ( dataItem: `DataItem`) => `void` Inherited from `IValueAxisSettings` 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
groupCount #	Type `undefined` \| `number` Default `500` Maximum number of data items in the view before data grouping kicks in. Click here for more info
groupData #	Type `undefined` \| `false` \| `true` Default `false` Should axis group data items togeter dynamically? Click here for more info
groupInterval #	Type `ITimeInterval` Force data item grouping to specific interval. Click here for more info
groupIntervals #	Type `Array` A list of intervals the axis is allowed to group data items into. 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
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
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
logarithmic #	Type `undefined` \| `false` \| `true` Inherited from `IValueAxisSettings` If set to `true` axis will use logarithmic scale. 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.
max #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Override maximum value for the axis scale. NOTE: the axis might modify the maximum value to fit into its scale better, unless `strictMinMax` is set to `true`. Click here for more info
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.
maxPrecision #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Maximum number of decimals to allow in axis labels. This setting not only affects formatting of the labels, but also where and how many grid/labels are placed on the axis. Click here for more info
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.
min #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Override minimum value for the axis scale. NOTE: the axis might modify the minimum value to fit into its scale better, unless `strictMinMax` is set to `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` 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
numberFormat #	Type `undefined` \| `string` Inherited from `IValueAxisSettings` Number format to use for axis labels. If not set, will use format set in global number formatter. 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.
scale #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Scale. Setting to a value less than 1 will shrink object.
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` Relative location of where axis cell starts: 0 - beginning, 1 - end. IMPORTANT: `startLocation` is not supported by `GaplessDateAxis`.
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.
strictMinMax #	Type `undefined` \| `false` \| `true` Inherited from `IValueAxisSettings` Force axis scale to be precisely at values as set in `min` and/or `max`. In case `min` and/or `max` is not set, the axis will fix its scale to precise lowest and highest values available through all of the series attached to it. This effectively locks the axis from auto-zooming itself when chart is zoomed in. If you need to zoom to actual low/high values within currently visible scope, use `strictMinMaxSelection` instead. Use `extraMin` and `extraMax` to add extra "padding". Click here for more info
strictMinMaxSelection #	Type `undefined` \| `false` \| `true` Inherited from `IValueAxisSettings` Force axis to auto-zoom to exact lowest and highest values from attached series' data items within ucurrently visible range. This is a good feature when your series is plotted from derivative values, like `valueYChangeSelection` as it helps to avoid frequent jumping of series to adjusted min and max of the axis. Use `extraMin` and `extraMax` to add extra "padding". @since 5.1.11
syncWithAxis #	Type `ValueAxis` Inherited from `IValueAxisSettings` This setting can be set to an instance of another `ValueAxis`. If set the grid of this axis will be synced with grid of the target axis. NOTE: this is not 100% guaranteed to work. In some rare cases perfect sync might not be possible. Click here for more info
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 `string` \| `DateTimeFormatOptions` A date format to use for axis tooltip. Click here for more info
tooltipDateFormats #	Type `undefined` \| `object` Time unit-specific formats to use for axis tooltip. Click here for more info @since 5.1.4
tooltipHTML #	Type `undefined` \| `string` Inherited from `ISpriteSettings` HTML content to show in a tooltip when hovered. @since 5.2.11
tooltipIntervalOffset #	Type `undefined` \| `number` A value which indicates relative position within axis cell to get timestamp for the tooltip from. Values are from `0` (zero) to `1` (one), meaning start and end of the cell. If not set, it will use cell's start tiemstamp. Click here for more info @since 5.1.4
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.
tooltipNumberFormat #	Type `string` \| `NumberFormatOptions` Inherited from `IValueAxisSettings` A numeric format used for numbers displayed in axis tooltip. Click here for more info
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.
treatZeroAs #	Type `undefined` \| `number` Inherited from `IValueAxisSettings` Treat zero values as some other value. Useful in situations where zero would result in error, i.e. logarithmic scale. Click here for more info
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
There are 100 inherited items currently hidden from this list.