StoryMapJS API
    Preparing search index...

    Interface StorymapSlide

    One slide of a storymap.

    The nullable members (| null) are not decoration: the storymap JSON uses null to mean "explicitly absent" and the viewer seeds its own defaults with null before the data is merged in, so a plain ? would not type.

    interface StorymapSlide {
        background?: string | StorymapSlideBackground | null;
        date?: string | Record<string, unknown> | null;
        group?: string;
        imgoverlay?: StorymapImageOverlay | null;
        language?: string;
        location?: StorymapSlideLocation | null;
        marker?: StorymapSlideMarker | null;
        media?: StorymapSlideMedia | null;
        media_extra?: StorymapSlideMedia[] | null;
        media_layout?: "stack" | "row";
        narration?: StorymapSlideNarration | null;
        provenance?: StorymapSlideProvenance | null;
        slidetimeout?: number;
        text?: StorymapSlideText | null;
        type?: string;
        uniqueid?: string | null;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    background? date? group? imgoverlay? language? location? marker? media? media_extra? media_layout? narration? provenance? slidetimeout? text? type? uniqueid?
    background?: string | StorymapSlideBackground | null
    date?: string | Record<string, unknown> | null
    group?: string
    imgoverlay?: StorymapImageOverlay | null

    Per-slide image overlay on the map (slideshow imgoverlay): a placed image shown while this slide is active. Absent means no overlay. Honored only with slideshow_source.

    language?: string

    The language tag this slide's text was read in. A IIIF manifest states its text as a language map; the reader picks the viewer's configured language and reports which one it used, so a host can offer a language switch. Absent for language-neutral (none) text, and for a single-language storymap.

    location?: StorymapSlideLocation | null
    marker?: StorymapSlideMarker | null
    media?: StorymapSlideMedia | null
    media_extra?: StorymapSlideMedia[] | null

    Additional visible media for this slide (#358), rendered after media in order. Items without a non-empty url are skipped, so a document without this field renders identically. In a IIIF manifest these are further painting annotations on the canvas; the slide layout (media_layout) has no IIIF term and stays viewer-side.

    media_layout?: "stack" | "row"

    Layout of a multi-media slide (#358): stack piles the items vertically (the panel scrolls), row puts two items side by side. Defaults to stack; row with anything but two items falls back to stack. Ignored for a single media item.

    narration?: StorymapSlideNarration | null
    provenance?: StorymapSlideProvenance | null

    Provenance identifiers for the slide's source (slideshow manifest_id/canvas_id/image_id): which manifest, canvas and image the stop was translated from. Data-only (deep links, export); never rendered.

    slidetimeout?: number

    Per-slide autoplay dwell in milliseconds (slideshow slidetimeout): overrides the global autoplay interval for this slide; 0 holds on this slide. Absent means the global interval. Honored only with slideshow_source.

    Optionaltext

    text?: StorymapSlideText | null
    type?: string
    uniqueid?: string | null

    Settings
    Member Visibility

    On This Page
    Properties