Interface TimelineLaneApi<S>

Timeline lane API

interface TimelineLaneApi<S extends TimelineLaneStyle = TimelineLaneStyle> {
    id: string;
    style: TimelineLaneStyle;
    addTimelineNode(config: TimelineLaneComponentConfig): TimelineNode;
    clearContent(): void;
    destroy(): void;
    isMinimized(): boolean;
    maximize(args?: TimelineLaneMinimizeMaximizeArgs): void;
    minimize(args?: TimelineLaneMinimizeMaximizeArgs): void;
    setStyle(style: Partial<S>): void;
    toggleMinimizeMaximize(args?: TimelineLaneMinimizeMaximizeArgs): void;
    updateAttrs(attrs: TimelineLaneUpdateableAttrs): void;
}

Type Parameters

S extends TimelineLaneStyle = TimelineLaneStyle

Hierarchy (View Summary)

Destroyable
OnMeasurementsChange
- TimelineLaneApi
  - MultiTrackTimelineLane

Index

Properties

Methods

addTimelineNode clearContent destroy isMinimized maximize minimize setStyle toggleMinimizeMaximize updateAttrs

Properties

id

id: string

Returns

TimelineLane id

style

style: TimelineLaneStyle

Methods

addTimelineNode

addTimelineNode(config: TimelineLaneComponentConfig): TimelineNode
Adds new timeline node to timeline lane
Parameters
- config: TimelineLaneComponentConfig
Returns TimelineNode
- Defined in src/timeline/timeline-lane-api.ts:73

clearContent

clearContent(): void
Clears Timeline lane content

Returns void
- Defined in src/timeline/timeline-lane-api.ts:66

destroy

destroy(): void
Returns void
Inherited from Destroyable.destroy
- Defined in src/common/capabilities.ts:23

isMinimized

isMinimized(): boolean
Returns boolean
is timeline lane minimized
- Defined in src/timeline/timeline-lane-api.ts:78

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
- Defined in src/timeline/timeline-lane-api.ts:96

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
- Defined in src/timeline/timeline-lane-api.ts:87

setStyle

setStyle(style: Partial<S>): void
Parameters
- style: Partial<S>
Returns void
- Defined in src/timeline/timeline-lane-api.ts:59

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
- Defined in src/timeline/timeline-lane-api.ts:105

updateAttrs

updateAttrs(attrs: TimelineLaneUpdateableAttrs): void
Parameters
- attrs: TimelineLaneUpdateableAttrs
Returns void
- Defined in src/timeline/timeline-lane-api.ts:61