Canvas Timeline
Interface

KeyframeInteractionLayerProps

Props for the delegated keyframe interaction layer.

Signature

Type Definition
Interface KeyframeInteractionLayerProps

Properties

NameSignatureDescription
collapsedTrackHeight?collapsedTrackHeight?: numberCollapsed track height in pixels.
edgeThreshold?edgeThreshold?: numberMouse/pen edge hit threshold in pixels.
getKeyframeAriaLabel?(keyframe: TimelineKeyframeHitTestResult): stringOptional accessible label formatter for a canvas-rendered keyframe.
hitPadding?hitPadding?: numberInvisible pointer padding in CSS pixels added around each keyframe handle. Presses inside the padded area target the keyframe instead of falling through to lower interaction layers such as the clip layer. Defaults to 8.
keyboardStepSeconds?keyboardStepSeconds?: numberKeyboard nudge amount in seconds for left/right arrow keys. Defaults to one 30fps frame.
keyframeSize?keyframeSize?: numberKeyframe affordance square size in CSS pixels.
keyframeValuePadding?keyframeValuePadding?: numberVertical padding used when mapping keyframe values into a clip row.
onKeyframeDelete?(keyframe: TimelineKeyframeRect, details: KeyframeDeleteDetails): voidOptional handler for Delete/Backspace key gestures on keyframe handles.
onKeyframeDoubleClick?(keyframe: TimelineKeyframeRect, details: KeyframeDoubleClickDetails): voidOptional handler for double-click or double-tap gestures on keyframe handles.
overscanPixels?overscanPixels?: numberExtra pixels around the viewport included in visible keyframe queries.
property?property?: "opacity"Keyframe property to render and hit-test. Defaults to all supported properties.
rulerHeight?rulerHeight?: numberHeight of the top ruler region in pixels.
selectedClipOnly?selectedClipOnly?: booleanOnly render keyframes owned by selected clips. Defaults to false.
touchEdgeThreshold?touchEdgeThreshold?: numberTouch edge hit threshold in pixels.
trackHeight?trackHeight?: numberDefault expanded track height in pixels.