Canvas Timeline
Type Alias

UseTimelineVisibleClipsOptions

Options accepted by `useTimelineVisibleClips`.

Signature

Type Definition
UseTimelineVisibleClipsOptions: VisibleTimelineClipOptions

Alias

UseTimelineVisibleClipsOptions aliases VisibleTimelineClipOptions from @techsquidtv/canvas-timeline-core.
Aliased Type Definition
Interface VisibleTimelineClipOptions

Options for building viewport-intersecting clip geometry.

Aliased properties

NameSignatureDescription
collapsedTrackHeight?collapsedTrackHeight?: numberCollapsed track height in pixels.
edgeThreshold?edgeThreshold?: numberMouse/pen edge hit threshold in pixels.
overscanPixels?overscanPixels?: numberExtra pixels around the viewport included in visibility tests.
rulerHeight?rulerHeight?: numberHeight of the top ruler region in pixels.
touchEdgeThreshold?touchEdgeThreshold?: numberTouch edge hit threshold in pixels.
trackHeight?trackHeight?: numberDefault expanded track height in pixels.
viewportHeight?viewportHeight?: numberOptional viewport height in CSS pixels for vertical filtering.
viewportWidth?viewportWidth?: numberViewport width in CSS pixels. Defaults to the engine viewport width.