StoryMapJS API
    Preparing search index...

    Interface StorymapSlideLocation

    Public data and options types for constructing a StoryMap.

    The data types are exported rather than only referenced: they are what a host actually types its document and options with, and TypeDoc warns about a documented member whose type it cannot link.

    interface StorymapSlideLocation {
        basemap?: string;
        filter?: StorymapSlideFilter;
        icon?: string;
        iconSize?: number[];
        image?: string;
        lat?: number;
        line?: boolean;
        lon?: number;
        mask?: StorymapSlideMask;
        region?: [number, number, number, number];
        rotation?: number;
        use_custom_marker?: boolean;
        zoom?: number;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    basemap? filter? icon? iconSize? image? lat? line? lon? mask? region? rotation? use_custom_marker? zoom?
    basemap?: string

    Per-slide basemap override (multi-manifest slideshow tours): any map_type value or IIIF info.json URL. Absent keeps the story basemap. The layer is cached, so returning to a slide is free. Honored only with slideshow_source.

    filter?: StorymapSlideFilter

    Per-slide image grading (slideshow filters): applied as a CSS filter() on the map viewport. All fields optional; absent means unfiltered. hueRotate is degrees (-180..180), blur is CSS pixels. Honored only with slideshow_source.

    icon?: string
    iconSize?: number[]
    image?: string
    lat?: number
    line?: boolean
    lon?: number
    mask?: StorymapSlideMask

    Spotlight mask (slideshow passepartout): normalized viewport fractions {x, y, w, h} (0..1) left visible while the rest is dimmed with color. invert dims the inside instead of the outside. Absent means no mask. Honored only with slideshow_source.

    region?: [number, number, number, number]

    Image region [x, y, w, h] in image pixels (IIIF xywh convention, slideshow-style image stops): the view fits the region on navigation; image maps (map_type: "iiif" + map_as_image) only.

    rotation?: number

    View rotation in degrees clockwise (slideshow rotation). Applied to the map view on navigation; absent means north-up (0). Image and geo maps alike; purely presentational. Honored only with slideshow_source.

    use_custom_marker?: boolean
    zoom?: number

    Settings
    Member Visibility

    On This Page
    Properties