Class BaseMultiTrackLane<C, S, T, TC>`Abstract`

Marks a timeline lane that manages multiple tracks. Use this type when you need to accept any multi-track lane without caring about its concrete type.

Type Parameters

Hierarchy (View Summary)

BaseTimelineLane<C, S>
- BaseMultiTrackLane
  - MarkerTrackLane
  - BaseObservationTrackLane

Implements

MultiTrackTimelineLane<C, S, T, TC>

Index

Accessors

id style

Methods

addTimelineNode addTrack clearContent destroy getTracks isMinimized maximize minimize removeTrack setStyle toggleMinimizeMaximize updateAttrs

Accessors

id

get id(): string
Returns string
TimelineLane id
Implementation of MultiTrackTimelineLane.id
Inherited from BaseTimelineLane.id
- Defined in src/timeline/timeline-lane.ts:400

style

get style(): S
Returns S
Implementation of MultiTrackTimelineLane.style
Inherited from BaseTimelineLane.style
- Defined in src/timeline/timeline-lane.ts:568

Methods

addTimelineNode

addTimelineNode(config: TimelineLaneComponentConfig): TimelineNode
Adds new timeline node to timeline lane
Parameters
- config: TimelineLaneComponentConfig
Returns TimelineNode
Implementation of MultiTrackTimelineLane.addTimelineNode
Inherited from BaseTimelineLane.addTimelineNode
- Defined in src/timeline/timeline-lane.ts:412

addTrack

addTrack(track: T, config?: TC): void
Adds a track to this lane. Accepts either the track object itself or its ID, in which case the track is resolved from the track repository.
Parameters
- track: T
- Optionalconfig: TC
  Optional per-track configuration (insertion index, style overrides, etc.).
Returns void
Throws
If a track with the same ID has already been added to this lane.

Throws
If an ID is provided but no matching track exists in the track repository.
Implementation of MultiTrackTimelineLane.addTrack
- Defined in src/timeline/track-lane.ts:299
addTrack(id: T["id"], config?: TC): void
Parameters
- id: T["id"]
- Optionalconfig: TC
Returns void
Implementation of MultiTrackTimelineLane.addTrack
- Defined in src/timeline/track-lane.ts:300

clearContent

clearContent(): void
Clears Timeline lane content

Returns void
Implementation of MultiTrackTimelineLane.clearContent
Inherited from BaseTimelineLane.clearContent
- Defined in src/timeline/timeline-lane.ts:387

destroy

destroy(): void
Returns void
Implementation of MultiTrackTimelineLane.destroy
Overrides BaseTimelineLane.destroy
- Defined in src/timeline/track-lane.ts:382

getTracks

getTracks(): T[]
Returns a shallow copy of all tracks currently added to this lane, in insertion order.

Returns T[]
Implementation of MultiTrackTimelineLane.getTracks
- Defined in src/timeline/track-lane.ts:369

isMinimized

isMinimized(): boolean
Returns boolean
is timeline lane minimized
Implementation of MultiTrackTimelineLane.isMinimized
Inherited from BaseTimelineLane.isMinimized
- Defined in src/timeline/timeline-lane.ts:433

maximize

maximize(args?: TimelineLaneMinimizeMaximizeArgs): void
Expands the lane back to its configured height.

Pass args.easing: true for an animated transition. When args is provided, args.complete is set to an Observable<void> that completes when the operation finishes (immediately for non-eased, after the animation for eased). Subscribe to args.complete after calling this method.
Parameters
- Optionalargs: TimelineLaneMinimizeMaximizeArgs
Returns void
Implementation of MultiTrackTimelineLane.maximize
Inherited from BaseTimelineLane.maximize
- Defined in src/timeline/timeline-lane.ts:480

minimize

minimize(args?: TimelineLaneMinimizeMaximizeArgs): void
Collapses the lane to zero height.

Pass args.easing: true for an animated transition. When args is provided, args.complete is set to an Observable<void> that completes when the operation finishes (immediately for non-eased, after the animation for eased). Subscribe to args.complete after calling this method.
Parameters
- Optionalargs: TimelineLaneMinimizeMaximizeArgs
Returns void
Implementation of MultiTrackTimelineLane.minimize
Inherited from BaseTimelineLane.minimize
- Defined in src/timeline/timeline-lane.ts:463

removeTrack

removeTrack(trackId: T["id"]): void
Parameters
- trackId: T["id"]
Returns void
- Defined in src/timeline/track-lane.ts:351

setStyle

setStyle(style: Partial<S>): void
Parameters
- style: Partial<S>
Returns void
Implementation of MultiTrackTimelineLane.setStyle
Inherited from BaseTimelineLane.setStyle
- Defined in src/timeline/timeline-lane.ts:573

toggleMinimizeMaximize

toggleMinimizeMaximize(args?: TimelineLaneMinimizeMaximizeArgs): void
Toggles between minimized and maximized states.

Pass args.easing: true for an animated transition. When args is provided, args.complete is set to an Observable<void> that completes when the operation finishes. Subscribe to args.complete after calling this method.
Parameters
- Optionalargs: TimelineLaneMinimizeMaximizeArgs
Returns void
Implementation of MultiTrackTimelineLane.toggleMinimizeMaximize
Inherited from BaseTimelineLane.toggleMinimizeMaximize
- Defined in src/timeline/timeline-lane.ts:560

updateAttrs

updateAttrs(attrs: TimelineLaneUpdateableAttrs): void
Parameters
- attrs: TimelineLaneUpdateableAttrs
Returns void
Implementation of MultiTrackTimelineLane.updateAttrs
Inherited from BaseTimelineLane.updateAttrs
- Defined in src/timeline/timeline-lane.ts:584

Class BaseMultiTrackLane<C, S, T, TC>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Accessors

Methods

Accessors

id

Returns string

style

Returns S

Methods

addTimelineNode

Parameters

Returns TimelineNode

addTrack

Parameters

Returns void

Throws

Throws

Parameters

Returns void

clearContent

Returns void

destroy

Returns void

getTracks

Returns T[]

isMinimized

Returns boolean

maximize

Parameters

Returns void

minimize

Parameters

Returns void

removeTrack

Parameters

Returns void

setStyle

Parameters

Returns void

toggleMinimizeMaximize

Parameters

Returns void

updateAttrs

Parameters

Returns void

Settings

On This Page

Class BaseMultiTrackLane<C, S, T, TC>`Abstract`