IDateAxisProperties

Type interface

Defines properties for DateAxis.

Sources

IDateAxisProperties is an interface: it describes a shape of data and is not imported on its own.

Inheritance

IDateAxisProperties extends IValueAxisProperties.

IDateAxisProperties is extended by IDateAxisAdapters.

Properties

groupCount

Type numberDefault 200Since 4.7.0

Indicates threshold of data items in selected range at which to start aggregating data items if groupData = true.

groupData

Type booleanDefault falseSince 4.7.0

Indicates if data should be aggregated to composide data items if there are more data items in selected range than groupCount.

groupInterval

Type ITimeIntervalSince 4.9.24

Disables automatic selection of data grouping intervals and always uses groupInterval if set. Works only if groupData = true.

markUnitChange

Type booleanDefault true

Use periodChangeDateFormats to apply different formats to the first label in bigger time unit.

skipEmptyPeriods

Type booleanDefault false

If enabled, axis will automatically collapse empty (without data points) periods of time, i.e. weekends.

snapTooltip

Type booleanDefault true

Should the nearest tooltip be shown if no data item is found on the current cursor position.

timezone

Type stringSince 4.10.1

If set will recalculate all timestamps in data to specific named timezone, e.g. "America/Vancouver", "Australia/Sydney", "UTC", etc.

IMPORTANT: do not set timezone on both DateAxis and dateFormatter. It will skew your results by applying timezone twice.

timezoneOffset

Type numberSince 4.8.5

If set will recalculate all timestamps in data by applying specific offset in minutes.

IMPORTANT: do not set timezoneOffset on both DateAxis and dateFormatter. It will skew your results by applying offset twice.

tooltipDateFormat

Type string | DateTimeFormatOptions

A special date format to apply axis tooltips.

Will use same format as for labels, if not set.

119 inherited items

adjustLabelPrecision

Type booleanInherited from IValueAxisProperties

align

Type AlignInherited from ISpriteProperties

alwaysShowTooltip

Type booleanInherited from ISpriteProperties

clickable

Type booleanInherited from ISpriteProperties

contentAlign

Type AlignInherited from IContainerProperties

Horizontal alignment of Container's items.

contextMenuDisabled

Type booleanInherited from ISpriteProperties

cursorTooltipEnabled

Type booleanInherited from IAxisProperties

Indicates if cusor's tooltip should be shown on this Axis.

disabled

Type booleanInherited from ISpriteProperties

draggable

Type booleanInherited from ISpriteProperties

dx

Type numberInherited from ISpriteProperties

dy

Type numberInherited from ISpriteProperties

endLocation

Type numberInherited from IAxisProperties

Axis end location.

0 - None of the last cell is shown. (don't do that)
0.5 - Half of the last cell is shown.
1 - Full last cell is shown.

extraMax

Type numberInherited from IValueAxisProperties

extraMin

Type numberInherited from IValueAxisProperties

extraTooltipPrecision

Type numberInherited from IValueAxisProperties

fill

Type Color | LinearGradient | RadialGradient | PatternInherited from ISpriteProperties

fillModifier

Type ColorModifierInherited from ISpriteProperties

fillOpacity

Type numberInherited from ISpriteProperties

fixedWidthGrid

Type booleanDefault falseInherited from IContainerProperties

If set to true, all columns of the container with layout type "grid" will be equally sized.

focusable

Type booleanInherited from ISpriteProperties

fontFamily

Type stringInherited from IContainerProperties

Font family for the text.

fontSize

Type numberInherited from IContainerProperties

Font size for the text.

fontWeight

Type FontWeightDefault "normal"Inherited from IContainerProperties

Default font weight.

height

Type number | PercentInherited from ISpriteProperties

hidden

Type booleanInherited from ISpriteProperties

hideTooltipWhileZooming

Type booleanDefault trueInherited from IAxisPropertiesSince 4.7.16

Indicates if axis' tooltip should be hidden while axis range is animating (zooming)

horizontalCenter

Type HorizontalCenterInherited from ISpriteProperties

hoverable

Type booleanInherited from ISpriteProperties

hoverOnFocus

Type booleanInherited from ISpriteProperties

id

Type stringInherited from ISpriteProperties

includeRangesInMinMax

Type booleanInherited from IValueAxisProperties

inert

Type booleanInherited from ISpriteProperties

interactionsEnabled

Type booleanInherited from ISpriteProperties

isActive

Type booleanInherited from ISpriteProperties

isHover

Type booleanInherited from ISpriteProperties

keepSelection

Type booleanInherited from IValueAxisProperties

layout

Type ContainerLayoutDefault "absolute"Inherited from IContainerProperties

Container layout.

Options: "absolute" (default), "vertical", "horizontal", or "grid".

logarithmic

Type booleanInherited from IValueAxisProperties

marginBottom

Type numberInherited from ISpriteProperties

marginLeft

Type numberInherited from ISpriteProperties

marginRight

Type numberInherited from ISpriteProperties

marginTop

Type numberInherited from ISpriteProperties

maxColumns

Type numberInherited from IContainerProperties

Maximum number of columns (when using "grid" layout).

maxHeight

Type numberInherited from ISpriteProperties

maxPrecision

Type numberInherited from IValueAxisProperties

maxWidth

Type numberInherited from ISpriteProperties

maxX

Type numberInherited from ISpriteProperties

maxY

Type numberInherited from ISpriteProperties

maxZoomCount

Type numberDefault 0 (no limit)Inherited from IComponentProperties

Use this for CategoryAxis or DateAxis.

Limits how many categories or base intervals can be shown at the same time.

If there are more items in the chart, the chart will auto-zoom.

maxZoomFactor

Type numberInherited from IComponentProperties

Maximum zoom factor of a component.

minHeight

Type numberInherited from ISpriteProperties

minWidth

Type numberInherited from ISpriteProperties

minX

Type numberInherited from ISpriteProperties

minY

Type numberInherited from ISpriteProperties

minZoomCount

Type numberDefault 1Inherited from IComponentProperties

Use this for CategoryAxis or DateAxis.

Allows restricting zoom in beyond certain number of categories or base intervals.

The chart will not zoom in beyond this number of items.

nonScaling

Type booleanInherited from ISpriteProperties

nonScalingStroke

Type booleanInherited from ISpriteProperties

opacity

Type numberInherited from ISpriteProperties

paddingBottom

Type numberInherited from ISpriteProperties

paddingLeft

Type numberInherited from ISpriteProperties

paddingRight

Type numberInherited from ISpriteProperties

paddingTop

Type numberInherited from ISpriteProperties

path

Type stringInherited from ISpriteProperties

pixelPerfect

Type booleanInherited from ISpriteProperties

readerChecked

Type booleanInherited from ISpriteProperties

readerControls

Type stringInherited from ISpriteProperties

readerDescribedBy

Type stringInherited from ISpriteProperties

readerDescription

Type stringInherited from ISpriteProperties

readerHidden

Type booleanInherited from ISpriteProperties

readerLabelledBy

Type stringInherited from ISpriteProperties

readerLive

Type AriaLiveInherited from ISpriteProperties

readerOrientation

Type stringInherited from ISpriteProperties

readerTitle

Type stringInherited from ISpriteProperties

readerValueNow

Type stringInherited from ISpriteProperties

readerValueText

Type stringInherited from ISpriteProperties

resizable

Type booleanInherited from ISpriteProperties

reverseOrder

Type booleanDefault falseInherited from IContainerProperties

If set to true, the children of the container will be drawn in reverse order.

role

Type RolesInherited from ISpriteProperties

rotation

Type numberInherited from ISpriteProperties

scale

Type numberInherited from ISpriteProperties

setStateOnChildren

Type booleanDefault falseInherited from IContainerProperties

Specifies if, when state is applied on this container, the same state should be applied to container's children as well as background.

shapeRendering

Type ShapeRenderingInherited from ISpriteProperties

showOnInit

Type booleanInherited from ISpriteProperties

showTooltipOn

Type "hover" | "hit" | "always"Inherited from ISpriteProperties

startLocation

Type numberInherited from IAxisProperties

Axis start location.

0 - None of the first cell is shown. (don't do that)
0.5 - Half of the first cell is shown.
1 - Full first cell is shown.

strictMinMax

Type booleanInherited from IValueAxisProperties

stroke

Type Color | LinearGradient | RadialGradient | PatternInherited from ISpriteProperties

strokeDasharray

Type stringInherited from ISpriteProperties

strokeDashoffset

Type numberInherited from ISpriteProperties

strokeLinecap

Type "butt" | "square" | "round"Inherited from ISpriteProperties

strokeLinejoin

Type "miter" | "round" | "bevel"Inherited from ISpriteProperties

strokeModifier

Type ColorModifierInherited from ISpriteProperties

strokeOpacity

Type numberInherited from ISpriteProperties

strokeWidth

Type numberInherited from ISpriteProperties

swipeable

Type booleanInherited from ISpriteProperties

syncWithAxis

Type ValueAxisInherited from IValueAxisProperties

tabindex

Type numberInherited from ISpriteProperties

textDecoration

Type TextDecorationDefault "none"Inherited from IContainerProperties

Default font decoration.

togglable

Type booleanInherited from ISpriteProperties

toggleZoomOutButton

Type booleanDefault trueInherited from IAxisProperties

Normally, when axis is zoomed in, a zoom out button is shown by a chart, and vice versa: when axis is zoomed out completely, zoom out button is hidden.

Setting this to false will disable this behavior. Zooming in our out this axis will not reveal or hide zoom out button.

tooltipHTML

Type stringInherited from ISpriteProperties

tooltipPosition

Type "fixed" | "pointer"Inherited from ISpriteProperties

tooltipText

Type stringInherited from ISpriteProperties

tooltipX

Type number | PercentInherited from ISpriteProperties

tooltipY

Type number | PercentInherited from ISpriteProperties

trackable

Type booleanInherited from ISpriteProperties

treatZeroAs

Type numberInherited from IValueAxisProperties

url

Type stringInherited from ISpriteProperties

urlTarget

Type stringInherited from ISpriteProperties

userClassName

Type stringInherited from ISpriteProperties

valign

Type VerticalAlignInherited from ISpriteProperties

verticalCenter

Type VerticalCenterInherited from ISpriteProperties

visible

Type booleanInherited from ISpriteProperties

wheelable

Type booleanInherited from ISpriteProperties

width

Type number | PercentInherited from ISpriteProperties

x

Type number | PercentInherited from ISpriteProperties

y

Type number | PercentInherited from ISpriteProperties

zIndex

Type numberInherited from ISpriteProperties

zoomable

Type booleanInherited from IAxisProperties