Usage notes
Use these options to scope keyframe reads to one clip, one property, selected clips, or visible viewport geometry. Geometry options should match the renderer and interaction layer so DOM overlays line up with canvas keyframe diamonds.
Signature
Interface UseTimelineKeyframesOptionsProperties
| Name | Signature | Description |
|---|---|---|
clipId? | clipId?: string | Optional clip id used to scope keyframe lists and commands. |
collapsedTrackHeight? | collapsedTrackHeight?: number | Collapsed track height in pixels. |
edgeThreshold? | edgeThreshold?: number | Mouse/pen edge hit threshold in pixels. |
keyframeSize? | keyframeSize?: number | Keyframe affordance square size in CSS pixels. |
keyframeValuePadding? | keyframeValuePadding?: number | Vertical padding used when mapping keyframe values into a clip row. |
overscanPixels? | overscanPixels?: number | Extra pixels around the viewport included in visibility tests. |
property? | property?: string | Only include keyframes for this property. Defaults to all supported properties. |
rulerHeight? | rulerHeight?: number | Height of the top ruler region in pixels. |
selectedClipOnly? | selectedClipOnly?: boolean | Only include keyframes belonging to selected clips. |
touchEdgeThreshold? | touchEdgeThreshold?: number | Touch edge hit threshold in pixels. |
trackHeight? | trackHeight?: number | Default expanded track height in pixels. |
viewportHeight? | viewportHeight?: number | Optional viewport height in CSS pixels for vertical filtering. |
viewportWidth? | viewportWidth?: number | Viewport width in CSS pixels. Defaults to the engine viewport width. |