Canvas Timeline
Interface

UseTimelineKeyframeCurvesOptions

Options accepted by `useTimelineKeyframeCurves`.

Signature

Type Definition
Interface UseTimelineKeyframeCurvesOptions

Properties

NameSignatureDescription
clipId?clipId?: stringOptional clip id used to scope curve segment lists and commands.
collapsedTrackHeight?collapsedTrackHeight?: numberCollapsed track height in pixels.
curveHandleSize?curveHandleSize?: numberBezier control handle affordance square size in CSS pixels.
edgeThreshold?edgeThreshold?: numberMouse/pen edge hit threshold in pixels.
keyframeSize?keyframeSize?: numberKeyframe affordance square size in CSS pixels.
keyframeValuePadding?keyframeValuePadding?: numberVertical padding used when mapping keyframe values into a clip row.
overscanPixels?overscanPixels?: numberExtra pixels around the viewport included in visibility tests.
property?property?: "opacity"Only include keyframes for this property. Defaults to all supported properties.
rulerHeight?rulerHeight?: numberHeight of the top ruler region in pixels.
selectedClipOnly?selectedClipOnly?: booleanOnly include keyframes belonging to selected clips.
selectedKeyframeOnly?selectedKeyframeOnly?: booleanOnly include curve segments touching a selected keyframe. Defaults to false.
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.