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

    Interface VerticalScrollApi

    interface VerticalScrollApi {
        onScroll$: Observable<VerticalScrollEvent>;
        scrollPercent: number;
        scrollBy(
            deltaPercent: number,
            options?: VerticalScrollOptions,
        ): Observable<number>;
        scrollTo(
            scrollPercent: number,
            options?: VerticalScrollOptions,
        ): Observable<number>;
    }
    Index

    Properties

    onScroll$ scrollPercent

    Methods

    scrollBy scrollTo

    Properties

    onScroll$: Observable<VerticalScrollEvent>

    Emits on every scroll change.

    scrollPercent: number

    Current scroll position in percent (0–100).

    Methods

    • Scroll to an absolute position (0–100%). The scroll (and any easing) starts immediately, regardless of whether the returned observable is subscribed to. Subscribe to be notified, asynchronously, once the scroll (including easing) has settled, with the final scroll percent.

      Parameters

      Returns Observable<number>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods