Interface TimelineLaneApi

Timeline lane API

interface TimelineLaneApi {
    style: TimelineLaneStyle;
    get id(): string;
    get mainLeftFlexGroup(): KonvaFlexGroup;
    get mainRightFlexGroup(): KonvaFlexGroup;
    addTimelineNode(config: TimelineLaneComponentConfig): TimelineNode;
    clearContent(): void;
    destroy(): void;
    getTimecodedPointerPosition(): undefined | Position;
    getTimecodedPointerPositionTime(): number;
    getTimecodedRect(): RectMeasurement;
    isMinimized(): boolean;
    maximize(): void;
    maximizeEased(): Observable<void>;
    minimize(): void;
    minimizeEased(): Observable<void>;
    onMeasurementsChange(): void;
    prepareForTimeline(
        timeline: Timeline,
        videoController: VideoControllerApi,
    ): void;
    toggleMinimizeMaximize(): void;
    toggleMinimizeMaximizeEased(): Observable<void>;
}

Hierarchy (View Summary)

Destroyable
OnMeasurementsChange
- TimelineLaneApi

Index

Properties

Accessors

id mainLeftFlexGroup mainRightFlexGroup

Methods

addTimelineNode clearContent destroy getTimecodedPointerPosition getTimecodedPointerPositionTime getTimecodedRect isMinimized maximize maximizeEased minimize minimizeEased onMeasurementsChange prepareForTimeline toggleMinimizeMaximize toggleMinimizeMaximizeEased

Properties

style

style: TimelineLaneStyle

Style getter / setter

Accessors

id

get id(): string
Returns string
TimelineLane id
- Defined in project/src/api/timeline-lane-api.ts:36

mainLeftFlexGroup

get mainLeftFlexGroup(): KonvaFlexGroup
Internal
Returns KonvaFlexGroup
- Defined in project/src/api/timeline-lane-api.ts:41

mainRightFlexGroup

get mainRightFlexGroup(): KonvaFlexGroup
Internal
Returns KonvaFlexGroup
- Defined in project/src/api/timeline-lane-api.ts:46

Methods

addTimelineNode

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

clearContent

clearContent(): void
Clears Timeline lane content

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

destroy

destroy(): void
Returns void
Inherited from Destroyable.destroy
- Defined in project/src/types/common.ts:22

getTimecodedPointerPosition

getTimecodedPointerPosition(): undefined | Position
Internal
Returns undefined | Position
- Defined in project/src/api/timeline-lane-api.ts:56

getTimecodedPointerPositionTime

getTimecodedPointerPositionTime(): number
Internal
Returns number
- Defined in project/src/api/timeline-lane-api.ts:61

getTimecodedRect

getTimecodedRect(): RectMeasurement
Internal
Returns RectMeasurement
- Defined in project/src/api/timeline-lane-api.ts:51

isMinimized

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

maximize

maximize(): void
Maximize

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

maximizeEased

maximizeEased(): Observable<void>
Maximize with easing

Returns Observable<void>
- Defined in project/src/api/timeline-lane-api.ts:98

minimize

minimize(): void
Minimize

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

minimizeEased

minimizeEased(): Observable<void>
Minimize with easing

Returns Observable<void>
- Defined in project/src/api/timeline-lane-api.ts:88

onMeasurementsChange

onMeasurementsChange(): void
Returns void
Inherited from OnMeasurementsChange.onMeasurementsChange
- Defined in project/src/common/measurement.ts:40

prepareForTimeline

prepareForTimeline(
timeline: Timeline,
videoController: VideoControllerApi,
): void
Internal
Parameters
- timeline: Timeline
- videoController: VideoControllerApi
Returns void
- Defined in project/src/api/timeline-lane-api.ts:116

toggleMinimizeMaximize

toggleMinimizeMaximize(): void
Toggles minimize / maximize

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

toggleMinimizeMaximizeEased

toggleMinimizeMaximizeEased(): Observable<void>
Toggles minimize / maximize with easing

Returns Observable<void>
- Defined in project/src/api/timeline-lane-api.ts:108