Canvas Timeline
Interface

CanvasRendererProps

Props for the timeline canvas renderer layer.

Signature

Type Definition
Interface CanvasRendererProps

Properties

NameSignatureDescription
className?className?: stringAdditional class names applied to the generated canvas element.
onRenderError?(error: CanvasRendererError): voidReceives setup and worker failures that prevent canvas rendering.
onRenderStats?(stats: CanvasRendererStats): voidReceives worker draw timing diagnostics when provided.
ruler?ruler?: TimelineRulerOptionsCanvas ruler tick and label configuration.
showClipDropFeedback?showClipDropFeedback?: booleanDraw cross-track clip drop feedback on the canvas layer.
showClipLabels?showClipLabels?: booleanDraw text labels inside visible clips.
showClips?showClips?: booleanDraw built-in clip bodies and labels on the canvas layer.
showInOutBoundaryLines?showInOutBoundaryLines?: booleanDraw canvas-painted in/out boundary lines for renderer-only compositions.
showInOutPoints?showInOutPoints?: booleanDraw the in/out range fill on the canvas layer.
showKeyframes?showKeyframes?: booleanDraw keyframe curves and handles inside visible clips.
showRulerLabels?showRulerLabels?: booleanDraw text labels on ruler ticks.
showSnapLines?showSnapLines?: booleanDraw magnetic snapping guide lines on the canvas layer.
theme?theme?: DeepPartial<TimelineRendererTheme>Canvas renderer theme overrides. CSS timeline variables are resolved before these overrides.
themeKey?themeKey?: string | numberChanges when CSS theme variables should be re-read, such as dark/light mode switches.