ZoomCharts Documentation

ZoomCharts.Configuration.TimeChartSettingsInteractionScrolling

Inheritance hierarchy

This type inherits from LinearChartSettingsInteractionScrolling.

Methods

This type does not define any methods.

Properties

enabled: boolean

Enables/Disables scrolling.

kineticFriction: number

Scrolling friction coefficient (chartWidth/ms^2).

limitFrom: number | "oldestData" | "oldestDataRounded"
Version 1.16.0: added support for 'oldestDataRounded'.

Limits scrolling in the left side. This should be either the timestamp value in milliseconds or the string constants 'oldestData' or 'oldestDataRounded'.

'oldestDataRounded' means that the scrolling limit will be the oldest data point rounded down for the currently visible major time unit (the bottom line in the time axis). For example, if the data starts on June, when viewing the whole year, the first half of the year will be shown empty.

Specify null to disable the limit.

limitMode: "snapBack" | "block"

Defines the chart behavior when the chart is scrolled passed the data limits. The actual limits are stored in limitFrom and limitTo.

Valid values:
  • snapBack - allow scrolling past the limit but scroll back.
  • block - do not allow to scroll past the limit
  • null - no limit scroll
limitTo: number | "newestData" | "now" | "newestDataRounded"
Version 1.16.0: added suport for 'newestDataRounded'.

Limits scrolling in the right side. This should be either the timestamp value in milliseconds or the string constants 'newestData', 'newestDataRounded' or 'now'.

'newestDataRounded' means that the scrolling limit will be the newest data point rounded up for the currently visible major time unit (the bottom line in the time axis). For example, if the data ends on June, when viewing the whole year, the second half of the year will be shown empty.

Specify null to disable the limit.

maxAnimationLength: number
Introduced in version 1.13.0.

The maximum time the scroll animation can run, in milliseconds. This does not apply when the user swipes the chart to start the animation, for that use kineticFriction instead. This setting however applies when the visible range is changed by using the toolbar or API methods.

Set to null to disable the limit.

overscrollProportion: number

Allows the user to scroll past the limit to a certain degree. This coefficient is multiplied to the overscroll area - so if overscrollProportion is set to 0.1 and the user scrolls 10 units past the limit, the chart will scroll back 9 units.

swipePageFlipping: boolean

Whether to use scrolling by full page instead of kinetic scrolling when using swipes (instead of dragging the chart).

X