@byomakase/omakase-player
    Preparing search index...

    Interface TimelineSlotApi

    interface TimelineSlotApi {
        onEvent$: Observable<TimelineSlotEvent>;
        scroll: VerticalScrollApi;
        type: TimelineSlotType;
        addTimelineLane(lane: TimelineLaneApi, index?: number): TimelineLaneApi;
        getContentHeight(): number;
        getEffectiveHeight(): number;
        getTimelineLanes(): TimelineLaneApi<TimelineLaneStyle>[];
        removeTimelineLane(id: string): void;
        scrollToLane(
            laneId: string,
            options?: VerticalScrollOptions,
        ): Observable<number>;
        setVerticalScrollbarVisible(visible: boolean): void;
    }
    Index

    Properties

    onEvent$ scroll type

    Methods

    addTimelineLane getContentHeight getEffectiveHeight getTimelineLanes removeTimelineLane scrollToLane setVerticalScrollbarVisible

    Properties

    onEvent$: Observable<TimelineSlotEvent>

    Stream of slot-level events: resize (TimelineSlotEventType.TIMELINE_SLOT_RESIZE) — whenever this slot's effective (viewport) or content height may have changed (lane minimize/maximize, add/remove, track updates, zoom, window resize, etc.) — and vertical scroll (TimelineSlotEventType.TIMELINE_SLOT_SCROLL), mirroring scroll's onScroll$ and only meaningful for the MAIN slot.

    scroll: VerticalScrollApi

    Vertical scroll API. Only meaningful for the MAIN slot — HEADER and FOOTER return a no-op adapter.

    type: TimelineSlotType

    Which slot region this is.

    Methods

    • Total height of this slot's content (sum of all lanes) in pixels, independent of any fixed/scrollable viewport height.

      Returns number

    • Explicitly show/hide the vertical scrollbar, on top of it auto-hiding when content fits the viewport. Only meaningful for the MAIN slot — no-op elsewhere. Visible by default.

      Parameters

      • visible: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods