Class TimeNavigator

Implements

IPrimitive

Index

Constructors

Methods

animating attached detached draw hitTest options setOptions setPointer zOrder

Constructors

constructor

new TimeNavigator(
opts?: Partial<TimeNavigatorOptions>,
now?: () => number,
): TimeNavigator
Parameters
- opts: Partial<TimeNavigatorOptions> = {}
- Optionalnow: () => number
Returns TimeNavigator
- Defined in src/primitives/time-navigator.ts:92

Methods

animating

animating(): boolean
Whether the fade is still running — the chart keeps painting while true.

Returns boolean
- Defined in src/primitives/time-navigator.ts:136

attached

attached(host: PrimitiveHost): void
Parameters
- host: PrimitiveHost
Returns void
Implementation of IPrimitive.attached
- Defined in src/primitives/time-navigator.ts:98

detached

detached(): void
Returns void
Implementation of IPrimitive.detached
- Defined in src/primitives/time-navigator.ts:99

draw

draw(ctx: CanvasRenderingContext2D, rc: PrimitiveRenderContext): void
Parameters
- ctx: CanvasRenderingContext2D
- rc: PrimitiveRenderContext
Returns void
Implementation of IPrimitive.draw
- Defined in src/primitives/time-navigator.ts:140

hitTest

hitTest(x: number, y: number): null | PrimitiveHit
Buttons hit-test only while visible, so a hidden navigator never steals a click from the chart body underneath it.
Parameters
- x: number
- y: number
Returns null | PrimitiveHit
Implementation of IPrimitive.hitTest
- Defined in src/primitives/time-navigator.ts:304

options

options(): TimeNavigatorOptions
Returns TimeNavigatorOptions
- Defined in src/primitives/time-navigator.ts:101

setOptions

setOptions(patch: Partial<TimeNavigatorOptions>): void
Parameters
- patch: Partial<TimeNavigatorOptions>
Returns void
- Defined in src/primitives/time-navigator.ts:103

setPointer

setPointer(p: null | { x: number; y: number }): void
Tell the navigator where the pointer is, in plot-local media px. null when it leaves. The chart calls this; hosts driving their own navigator should too.
Parameters
- p: null | { x: number; y: number }
Returns void
- Defined in src/primitives/time-navigator.ts:113

zOrder

zOrder(): ZOrder
Layer order vs series: 'bottom' (behind), 'normal' (over), 'top' (overlay).

Returns ZOrder
Implementation of IPrimitive.zOrder
- Defined in src/primitives/time-navigator.ts:100