Canvas Timeline
Interface

TimelinePanControlOptions

Options for adapting horizontal timeline scroll to a scalar control.

Signature

Type Definition
Interface TimelinePanControlOptions

Properties

NameSignatureDescription
label?label?: stringAccessible label for the pan control.
max?max?: numberMaximum scroll offset in pixels. Defaults to the engine max scroll left.
min?min?: numberMinimum scroll offset in pixels. Defaults to 0.
onValueCommitted?(value: number[], eventDetails?: unknown): voidCalled after the hook applies a committed control value to the engine. When the underlying scalar control provides commit details, Canvas Timeline forwards them unchanged as the second argument and does not read their fields.
step?step?: numberSlider step in pixels. Defaults to 1.