Documentation

IDateAxisProperties

Type interface

Defines properties for DateAxis.

Inheritance

IDateAxisProperties extends IValueAxisProperties.

IDateAxisProperties is extended by IDateAxisAdapters.

Properties

adjustLabelPrecision
#

Type boolean

Inherited from IValueAxisProperties
align
#

Type Align

Inherited from ISpriteProperties
alwaysShowTooltip
#

Type boolean

Inherited from ISpriteProperties
clickable
#

Type boolean

Inherited from ISpriteProperties
contentAlign
#

Type Align

Inherited from IContainerProperties

Horizontal alignment of Container's items.
contextMenuDisabled
#

Type boolean

Inherited from ISpriteProperties
cursorTooltipEnabled
#

Type boolean

Inherited from IAxisProperties

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

Type boolean

Inherited from ISpriteProperties
draggable
#

Type boolean

Inherited from ISpriteProperties
dx
#

Type number

Inherited from ISpriteProperties
dy
#

Type number

Inherited from ISpriteProperties
endLocation
#

Type number

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

@param Location (0-1)

extraMax
#

Type number

Inherited from IValueAxisProperties
extraMin
#

Type number

Inherited from IValueAxisProperties
extraTooltipPrecision
#

Type number

Inherited from IValueAxisProperties
fill
#

Type Color | LinearGradient | RadialGradient | Pattern

Inherited from ISpriteProperties
fillModifier
#

Type ColorModifier

Inherited from ISpriteProperties
fillOpacity
#

Type number

Inherited from ISpriteProperties
fixedWidthGrid
#

Type boolean

Default false

Inherited from IContainerProperties

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

Type boolean

Inherited from ISpriteProperties
fontFamily
#

Type string

Inherited from IContainerProperties

Font family for the text.
fontSize
#

Type number

Inherited from IContainerProperties

Font size for the text.
fontWeight
#

Type FontWeight

Default "normal"

Inherited from IContainerProperties

Default font weight.
groupCount
#

Type number

Default 200

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

@since 4.7.0

groupData
#

Type boolean

Default false

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

@since 4.7.0

groupInterval
#

Type ITimeInterval

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

@since 4.9.24

height
#

Type number | Percent

Inherited from ISpriteProperties
hidden
#

Type boolean

Inherited from ISpriteProperties
hideTooltipWhileZooming
#

Type boolean

Default true

Inherited from IAxisProperties

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

@since 4.7.16

horizontalCenter
#

Type HorizontalCenter

Inherited from ISpriteProperties
hoverOnFocus
#

Type boolean

Inherited from ISpriteProperties
hoverable
#

Type boolean

Inherited from ISpriteProperties
id
#

Type string

Inherited from ISpriteProperties
includeRangesInMinMax
#

Type boolean

Inherited from IValueAxisProperties
inert
#

Type boolean

Inherited from ISpriteProperties
interactionsEnabled
#

Type boolean

Inherited from ISpriteProperties
isActive
#

Type boolean

Inherited from ISpriteProperties
isHover
#

Type boolean

Inherited from ISpriteProperties
keepSelection
#

Type boolean

Inherited from IValueAxisProperties
layout
#

Type ContainerLayout

Default "absolute"

Inherited from IContainerProperties

Container layout.

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

Type boolean

Inherited from IValueAxisProperties
marginBottom
#

Type number

Inherited from ISpriteProperties
marginLeft
#

Type number

Inherited from ISpriteProperties
marginRight
#

Type number

Inherited from ISpriteProperties
marginTop
#

Type number

Inherited from ISpriteProperties
markUnitChange
#

Type boolean

Default true

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

@param Use different format for period beginning?

maxColumns
#

Type number

Inherited from IContainerProperties

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

Type number

Inherited from ISpriteProperties
maxPrecision
#

Type number

Inherited from IValueAxisProperties
maxWidth
#

Type number

Inherited from ISpriteProperties
maxX
#

Type number

Inherited from ISpriteProperties
maxY
#

Type number

Inherited from ISpriteProperties
maxZoomCount
#

Type number

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

Inherited from IComponentProperties

Maximum zoom factor of a component.
minHeight
#

Type number

Inherited from ISpriteProperties
minWidth
#

Type number

Inherited from ISpriteProperties
minX
#

Type number

Inherited from ISpriteProperties
minY
#

Type number

Inherited from ISpriteProperties
minZoomCount
#

Type number

Default 1

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

Inherited from ISpriteProperties
nonScalingStroke
#

Type boolean

Inherited from ISpriteProperties
opacity
#

Type number

Inherited from ISpriteProperties
paddingBottom
#

Type number

Inherited from ISpriteProperties
paddingLeft
#

Type number

Inherited from ISpriteProperties
paddingRight
#

Type number

Inherited from ISpriteProperties
paddingTop
#

Type number

Inherited from ISpriteProperties
path
#

Type string

Inherited from ISpriteProperties
pixelPerfect
#

Type boolean

Inherited from ISpriteProperties
readerChecked
#

Type boolean

Inherited from ISpriteProperties
readerControls
#

Type string

Inherited from ISpriteProperties
readerDescribedBy
#

Type string

Inherited from ISpriteProperties
readerDescription
#

Type string

Inherited from ISpriteProperties
readerHidden
#

Type boolean

Inherited from ISpriteProperties
readerLabelledBy
#

Type string

Inherited from ISpriteProperties
readerLive
#

Type AriaLive

Inherited from ISpriteProperties
readerOrientation
#

Type string

Inherited from ISpriteProperties
readerTitle
#

Type string

Inherited from ISpriteProperties
readerValueNow
#

Type string

Inherited from ISpriteProperties
readerValueText
#

Type string

Inherited from ISpriteProperties
resizable
#

Type boolean

Inherited from ISpriteProperties
reverseOrder
#

Type boolean

Default false

Inherited from IContainerProperties

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

Type Roles

Inherited from ISpriteProperties
rotation
#

Type number

Inherited from ISpriteProperties
scale
#

Type number

Inherited from ISpriteProperties
setStateOnChildren
#

Type boolean

Default false

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

Inherited from ISpriteProperties
showOnInit
#

Type boolean

Inherited from ISpriteProperties
showTooltipOn
#

Type "hover" | "hit" | "always"

Inherited from ISpriteProperties
skipEmptyPeriods
#

Type boolean

Default false

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

Type boolean

Default true

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

Type number

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

@param Location (0-1)

strictMinMax
#

Type boolean

Inherited from IValueAxisProperties
stroke
#

Type Color | LinearGradient | RadialGradient | Pattern

Inherited from ISpriteProperties
strokeDasharray
#

Type string

Inherited from ISpriteProperties
strokeDashoffset
#

Type number

Inherited from ISpriteProperties
strokeLinecap
#

Type "butt" | "square" | "round"

Inherited from ISpriteProperties
strokeLinejoin
#

Type "miter" | "round" | "bevel"

Inherited from ISpriteProperties
strokeModifier
#

Type ColorModifier

Inherited from ISpriteProperties
strokeOpacity
#

Type number

Inherited from ISpriteProperties
strokeWidth
#

Type number

Inherited from ISpriteProperties
swipeable
#

Type boolean

Inherited from ISpriteProperties
syncWithAxis
#

Type ValueAxis

Inherited from IValueAxisProperties
tabindex
#

Type number

Inherited from ISpriteProperties
textDecoration
#

Type TextDecoration

Default "none"

Inherited from IContainerProperties

Default font decoration.
timezone
#

Type string

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.

@since 4.10.1

timezoneOffset
#

Type number

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.

@since 4.8.5

togglable
#

Type boolean

Inherited from ISpriteProperties
toggleZoomOutButton
#

Type boolean

Default true

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

Type string | DateTimeFormatOptions

A special date format to apply axis tooltips.

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

Type string

Inherited from ISpriteProperties
tooltipPosition
#

Type "fixed" | "pointer"

Inherited from ISpriteProperties
tooltipText
#

Type string

Inherited from ISpriteProperties
tooltipX
#

Type number | Percent

Inherited from ISpriteProperties
tooltipY
#

Type number | Percent

Inherited from ISpriteProperties
trackable
#

Type boolean

Inherited from ISpriteProperties
treatZeroAs
#

Type number

Inherited from IValueAxisProperties
url
#

Type string

Inherited from ISpriteProperties
urlTarget
#

Type string

Inherited from ISpriteProperties
userClassName
#

Type string

Inherited from ISpriteProperties
valign
#

Type VerticalAlign

Inherited from ISpriteProperties
verticalCenter
#

Type VerticalCenter

Inherited from ISpriteProperties
visible
#

Type boolean

Inherited from ISpriteProperties
wheelable
#

Type boolean

Inherited from ISpriteProperties
width
#

Type number | Percent

Inherited from ISpriteProperties
x
#

Type number | Percent

Inherited from ISpriteProperties
y
#

Type number | Percent

Inherited from ISpriteProperties
zIndex
#

Type number

Inherited from ISpriteProperties
zoomable
#

Type boolean

Inherited from IAxisProperties
There are 119 inherited items currently hidden from this list.