Diva.js Public API - v7.4.0
    Preparing search index...

    Interface DivaState

    A point-in-time snapshot of public viewer state.

    interface DivaState {
        resourceUrl: string;
        ready: boolean;
        loading: boolean;
        pageCount: number;
        currentPageIndex: number | null;
        visiblePageIndexes: readonly number[];
        layoutMode: DivaLayoutMode;
        viewingDirection: DivaViewingDirection;
        zoom: number | null;
        fullscreen: boolean;
        destroyed: boolean;
    }
    Index
    resourceUrl ready loading pageCount currentPageIndex visiblePageIndexes layoutMode viewingDirection zoom fullscreen destroyed
    resourceUrl: string

    URL of the successfully loaded IIIF manifest or collection.

    ready: boolean

    Whether the current resource and its required initial page are ready.

    loading: boolean

    Whether resource or image work affecting the viewer is in progress.

    pageCount: number

    Number of displayable pages in the current resource.

    currentPageIndex: number | null

    Zero-based active page index, or null when no page is active.

    visiblePageIndexes: readonly number[]

    Zero-based indexes in the active row or opening.

    layoutMode: DivaLayoutMode

    Current page arrangement.

    viewingDirection: DivaViewingDirection

    Current direction of pages within an opening.

    zoom: number | null

    Current OpenSeadragon viewport zoom, or null before initialization.

    fullscreen: boolean

    Whether a document element is currently fullscreen.

    destroyed: boolean

    Whether Diva.destroy has permanently disposed of the instance.

    Settings
    Member Visibility

    On This Page
    Properties