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

    Interface DivaOptions

    Constructor options for a Diva viewer.

    interface DivaOptions {
        objectData: string;
        initialPage?: DivaPageTarget;
        acceptHeaders?: string[];
        enableAnnotations?: boolean;
        enableAnnotationSelection?: boolean;
        annotationServer?: string;
        staticImageCorsPolicy?: DivaStaticImageCorsPolicy;
        showSidebar?: boolean;
        sidebarWidth?: number;
        sidebarPanel?: DivaSidebarPanel;
        showTitle?: boolean;
        setLanguage?: string;
    }
    Index
    objectData initialPage? acceptHeaders? enableAnnotations? enableAnnotationSelection? annotationServer? staticImageCorsPolicy? showSidebar? sidebarWidth? sidebarPanel? showTitle? setLanguage?
    objectData: string

    URL of the initial IIIF manifest or collection.

    initialPage?: DivaPageTarget

    Page to display when the initial manifest opens.

    Numeric values are zero-based. Selector matching follows DivaPageSelector. Invalid or unmatched targets silently fall back to page index 0. This option applies only to the initial manifest; resources loaded later begin at index 0.

    acceptHeaders?: string[]

    Preferred HTTP Accept values for IIIF resource requests.

    enableAnnotations?: boolean

    Enable manifest-driven IIIF annotation overlays.

    false

    enableAnnotationSelection?: boolean

    Enable selecting annotations by clicking or keyboard activation.

    true

    annotationServer?: string

    Optional GET endpoint used when a canvas declares no annotation resources.

    staticImageCorsPolicy?: DivaStaticImageCorsPolicy

    CORS policy for static image bodies without an IIIF Image API service.

    fallback attempts anonymous CORS first and makes one non-CORS retry when that load fails. none loads static images without CORS immediately. Non-CORS images remain viewable, but Page View pixel filters and saving are unavailable because the browser taints their canvas.

    "required"

    showSidebar?: boolean

    Show the navigation sidebar.

    true

    sidebarWidth?: number

    Initial width of the thumbnail and contents sidebar, in CSS pixels.

    Finite values are rounded and constrained to the supported 220–520 pixel resize range. Invalid runtime values use the default.

    320

    sidebarPanel?: DivaSidebarPanel

    Panel selected when the navigation sidebar is first shown.

    Contents requires manifest ranges, and Metadata requires manifest metadata or homepage links. Diva falls back to Thumbnails when the requested panel is not available for the loaded manifest.

    "thumbnails"

    showTitle?: boolean

    Show the resource title.

    true

    setLanguage?: string

    Preferred interface language; otherwise the browser language is used.

    Settings
    Member Visibility

    On This Page
    Properties