Interface

UseTimelineTrackHeaderResult

Result returned by `useTimelineTrackHeader`.

Signature

Type Definition
Interface UseTimelineTrackHeaderResult

Type parameters

NameConstraintDefaultDescription
TrackKindstringstringNo type parameter summary yet.

Properties

NameSignatureDescription
collapsedcollapsed: booleanWhether the track row is collapsed.
existsexists: booleanWhether the requested track exists.
groupIdgroupId: string | undefinedOptional track group id.
heightheight: numberExpanded row height in pixels, matching canvas geometry.
kindkind: TrackKind | nullApp-defined track kind, or null when the track is missing.
labellabel: stringHuman-readable label for the header row.
lockedlocked: booleanWhether the track is locked for editing.
mutedmuted: booleanWhether the track is muted.
namename: string | undefinedUser-facing track name, when set.
rectrect: TimelineTrackRect | nullViewport row rectangle matching canvas track geometry.
rootPropsrootProps: TimelineTrackHeaderRootPropsProps for the root track header row element.
selectedselected: booleanWhether the track itself is selected.
selectTrack(): TimelineCommandResultSelects this track.
setLocked(locked: boolean): TimelineCommandResultSets this track's locked state.
setMuted(muted: boolean): TimelineCommandResultSets this track's muted state.
setTrackGroup(groupId: string | undefined): TimelineCommandResultAssigns this track to a group, or clears its group.
setTrackHeight(height: number): TimelineCommandResultSets this track's expanded display height in pixels.
setTrackTarget(targeted: boolean): TimelineCommandResultSets this track's edit-targeted state.
setVisible(visible: boolean): TimelineCommandResultSets this track's output visibility.
targetedtargeted: booleanWhether the track is targeted for edit operations.
toggleLock(locked?: boolean): TimelineCommandResultSets or toggles this track's locked state.
toggleMute(muted?: boolean): TimelineCommandResultSets or toggles this track's muted state.
toggleTrackTarget(targeted?: boolean): TimelineCommandResultSets or toggles this track's edit-targeted state.
toggleVisibility(visible?: boolean): TimelineCommandResultSets or toggles this track's output visibility.
tracktrack: Track<TrackKind> | nullCurrent track, or null when the id is missing.
trackIdtrackId: stringRequested track id.
trackIndextrackIndex: numberZero-based track index, or -1 when the track is missing.
visiblevisible: booleanWhether the track participates in active layer and media lookup.