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

    Interface DivaEventMap

    Typed details for events dispatched by a Diva instance.

    interface DivaEventMap {
        ready: CustomEvent<Readonly<DivaState>>;
        resourcechange: CustomEvent<
            { resourceUrl: string; state: Readonly<DivaState> },
        >;
        pagechange: CustomEvent<
            {
                pageIndex: number;
                page: DivaPage;
                visiblePages: readonly DivaPage[];
            },
        >;
        layoutchange: CustomEvent<
            { layoutMode: DivaLayoutMode; viewingDirection: DivaViewingDirection },
        >;
        zoomchange: CustomEvent<{ zoom: number }>;
        loadingchange: CustomEvent<{ loading: boolean }>;
        fullscreenchange: CustomEvent<{ fullscreen: boolean }>;
        error: CustomEvent<
            { error: Error; operation: string; recoverable: boolean },
        >;
    }
    Index
    ready resourcechange pagechange layoutchange zoomchange loadingchange fullscreenchange error
    ready: CustomEvent<Readonly<DivaState>>

    Fired once after the initial resource and selected initial page are ready.

    resourcechange: CustomEvent<{ resourceUrl: string; state: Readonly<DivaState> }>

    Fired after an initial or replacement IIIF resource becomes ready.

    pagechange: CustomEvent<
        { pageIndex: number; page: DivaPage; visiblePages: readonly DivaPage[] },
    >

    Fired when the active page changes.

    layoutchange: CustomEvent<
        { layoutMode: DivaLayoutMode; viewingDirection: DivaViewingDirection },
    >

    Fired when the single-page or spread arrangement changes.

    zoomchange: CustomEvent<{ zoom: number }>

    Fired when the OpenSeadragon viewport zoom changes.

    loadingchange: CustomEvent<{ loading: boolean }>

    Fired when combined resource/image loading state changes.

    fullscreenchange: CustomEvent<{ fullscreen: boolean }>

    Fired when browser fullscreen state changes.

    error: CustomEvent<{ error: Error; operation: string; recoverable: boolean }>

    Fired for resource or image failures that clients may want to report.

    Settings
    Member Visibility

    On This Page
    Properties