Usage notes
Use these options for dense app-owned visuals such as waveforms, subtitles, annotations, audio peaks, thumbnail strips, or analysis overlays. Geometry options should match the primary renderer so custom drawings line up with clip and keyframe positions.
Signature
Interface UseTimelineCanvasLayerOptionsType parameters
| Name | Constraint | Default | Description |
|---|---|---|---|
TrackKind | None | string | App-defined track kind values carried by draw geometry. |
Properties
| Name | Signature | Description |
|---|---|---|
clearBeforeDraw? | clearBeforeDraw?: boolean | Clear the canvas before each draw. Defaults to true. |
collapsedTrackHeight? | collapsedTrackHeight?: number | Collapsed track height in pixels. |
draw | draw: TimelineCanvasLayerDraw<TrackKind> | Draws custom timeline visuals into an app-owned canvas. |
edgeThreshold? | edgeThreshold?: number | Mouse/pen edge hit threshold in pixels. |
overscanPixels? | overscanPixels?: number | Extra pixels around the viewport included in visible clip queries. |
redrawOnPlayhead? | redrawOnPlayhead?: boolean | Redraw when only the playhead changes. Defaults to false. |
rulerHeight? | rulerHeight?: number | Height of the top ruler region in pixels. |
touchEdgeThreshold? | touchEdgeThreshold?: number | Touch edge hit threshold in pixels. |
trackHeight? | trackHeight?: number | Default expanded track height in pixels. |