TimelineHandle
Defined in: src/components/editor/Timeline/Timeline.types.ts:127
Imperative handle exposed via ref on <Timeline>. Stable for the
lifetime of the component.
Methods
Section titled “Methods”focus()
Section titled “focus()”focus():
void
Defined in: src/components/editor/Timeline/Timeline.types.ts:129
Focus the timeline body so keyboard navigation starts working.
Returns
Section titled “Returns”void
frameToX()
Section titled “frameToX()”frameToX(
frame):number
Defined in: src/components/editor/Timeline/Timeline.types.ts:151
Map a frame to a track-area CSS-pixel X.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
getElement()
Section titled “getElement()”getElement():
HTMLDivElement|null
Defined in: src/components/editor/Timeline/Timeline.types.ts:131
Access the underlying body DOM element.
Returns
Section titled “Returns”HTMLDivElement | null
getFrame()
Section titled “getFrame()”getFrame():
number
Defined in: src/components/editor/Timeline/Timeline.types.ts:141
Current playhead frame.
Returns
Section titled “Returns”number
getView()
Section titled “getView()”getView():
TimelineView
Defined in: src/components/editor/Timeline/Timeline.types.ts:147
Current visible frame window.
Returns
Section titled “Returns”pause()
Section titled “pause()”pause():
void
Defined in: src/components/editor/Timeline/Timeline.types.ts:137
Pause playback.
Returns
Section titled “Returns”void
play()
Section titled “play()”play():
void
Defined in: src/components/editor/Timeline/Timeline.types.ts:135
Start playback.
Returns
Section titled “Returns”void
seek()
Section titled “seek()”seek(
frame):void
Defined in: src/components/editor/Timeline/Timeline.types.ts:133
Move the playhead to a frame (snapped + clamped).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
setView()
Section titled “setView()”setView(
view):void
Defined in: src/components/editor/Timeline/Timeline.types.ts:149
Set the visible frame window (clamped to bounds + minFramesVisible).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
toggle()
Section titled “toggle()”toggle():
void
Defined in: src/components/editor/Timeline/Timeline.types.ts:139
Toggle playback.
Returns
Section titled “Returns”void
xToFrame()
Section titled “xToFrame()”xToFrame(
x):number
Defined in: src/components/editor/Timeline/Timeline.types.ts:153
Inverse of frameToX.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”number
zoomToFit()
Section titled “zoomToFit()”zoomToFit(
paddingFrames?):void
Defined in: src/components/editor/Timeline/Timeline.types.ts:143
Fit the view to the whole frame range, with optional padding (frames).
Parameters
Section titled “Parameters”paddingFrames?
Section titled “paddingFrames?”number
Returns
Section titled “Returns”void
zoomToSelection()
Section titled “zoomToSelection()”zoomToSelection():
void
Defined in: src/components/editor/Timeline/Timeline.types.ts:145
Fit the view to the current selection. No-op when nothing is selected.
Returns
Section titled “Returns”void