UseTimelineKeyframeSegmentsOptions API

Signature

Interface UseTimelineKeyframeSegmentsOptions

Name	Signature	Description
`clipId?`	`clipId?: string`	Optional clip id used to scope segment 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`	Keyframe property used to scope segment lists and commands.
`rulerHeight?`	`rulerHeight?: number`	Height of the top ruler region in pixels.
`selectedClipOnly?`	`selectedClipOnly?: boolean`	Only include keyframes belonging to selected clips.
`selectedKeyframeOnly?`	`selectedKeyframeOnly?: boolean`	Only include segments touching a selected keyframe. Defaults to false.
`tangentHandleSize?`	`tangentHandleSize?: number`	Bezier tangent affordance square size in CSS pixels.
`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.