papi-dts
    Preparing search index...

    Interface IScrollGroupService

    Provides functions related to scroll groups and Scripture references at those scroll groups

    interface IScrollGroupService {
        onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>;
        getScrRef(scrollGroupId?: number): Promise<SerializedVerseRef>;
        setScrRef(
            scrollGroupId: undefined | number,
            scrRef: SerializedVerseRef,
        ): Promise<boolean>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    onDidUpdateScrRef

    Methods

    getScrRef setScrRef

    Properties

    onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>

    Event that emits with information about a changed Scripture Reference for a scroll group

    Methods

    • Get the SerializedVerseRef associated with the provided scroll group

      Parameters

      • OptionalscrollGroupId: number

        Scroll group whose Scripture reference to get. Defaults to 0

      Returns Promise<SerializedVerseRef>

      Scripture reference associated with the provided scroll group

    • Sets the SerializedVerseRef associated with the provided scroll group

      Parameters

      • scrollGroupId: undefined | number

        Scroll group whose Scripture reference to get. If undefined, defaults to 0

      • scrRef: SerializedVerseRef

        Scripture reference to which to set the scroll group

      Returns Promise<boolean>

      true if the Scripture reference changed. false otherwise

    Settings

    Member Visibility

    On This Page

    Properties
    Methods