Timeline Control
Last updated
Last updated
Timeline control allows playing datetimes as animation with linear interpolation between two subsequent datetimes
TimelineControl(config: TimelineConfig = {})
width
Type: number, optional
Default: 300
Width of the control.
datetimes
Datetimes to be displayed in the timeline.
datetimeInterpolate
Type: boolean, optional
Default: true
datetime
Current datetime selected in the timeline.
onPreload
Preload callback, use for preloading requested data.
If an array of promises is returned, the progress is displayed in the loader text.
onUpdate
Update callback, use for updating displayed data.
fps
Type: number, optional
Default: 15
Timeline animation speed, in frames per seconds. Lower number is slower animation, higher number is faster animation.
toggle(running?: boolean): Promise<void>
Toggles (starts or pauses) the timeline animation.
Before starting, it calls and awaits onPreload
with all datetimes.
start(): Promise<void>
Starts the timeline animation.
Before starting, it calls and awaits onPreload
with all datetimes.
pause(): void
Pauses the timeline animation.
stop(): void
Stops (pauses and resets) the timeline animation.
reset(): void
Resets the timeline animation.
stepBackward(): Promise<void>
Steps backward in the timeline animation.
Before stepping, it calls and awaits onPreload
with datetimes required to display the requested step.
stepForward(): Promise<void>
Steps forward in the timeline animation.
Before stepping, it calls and awaits onPreload
with datetimes required to display the requested step.
Type: []
, required
Type: , required
Type: (datetimes:
[]) => Promise<void>[] | Promise<void>
, optional
Type: (datetime:
) => void
, optional
See for common Control methods.