g3-toolkit API Reference
    Preparing search index...

    Interface OverlaySequence

    interface OverlaySequence {
        goTo: (index: number) => void;
        index: number;
        isPlaying: boolean;
        length: number;
        next: () => void;
        pause: () => void;
        play: () => void;
        prev: () => void;
    }
    Index

    Properties

    goTo index isPlaying length next pause play prev

    Properties

    goTo: (index: number) => void

    Jump to a step; out-of-range values clamp. Does not change playback.

    index: number

    Current step, 0-based; always within [0, length - 1] (0 when empty).

    isPlaying: boolean
    length: number

    Number of steps (ids.length).

    next: () => void
    pause: () => void
    play: () => void
    prev: () => void

    Settings

    Member Visibility

    On This Page

    Properties