StoryMapJS API
    Preparing search index...

    Interface StorymapOverlayLayer

    A stacked raster overlay above the base map (StorymapOptions.overlays). Presentation is declarative: hosts no longer need to reach into the layer objects for blend modes, clips or stacking tweaks.

    interface StorymapOverlayLayer {
        attribution?: string;
        blendMode?: string;
        className?: string;
        control?: boolean;
        extent?: [number, number, number, number];
        georeference?: StorymapGeoreference;
        label?: string | (() => string);
        locked?: boolean;
        map_type?: string;
        opacity?: number;
        visible?: boolean;
    }
    Index
    attribution?: string

    Extra attribution fragment, listed while the overlay is visible

    blendMode?: string

    CSS mix-blend-mode for the layer container (needs className)

    className?: string

    CSS class for the layer container. OpenLayers paints every layer with the same class into one shared div/canvas, so a distinct class isolates this layer (e.g. for blend modes). The class replaces the default wholesale, so keep the ol-layer token (e.g. "ol-layer historic-sheet") unless you know why not.

    control?: boolean

    false hides the row from the control without removing the overlay.

    extent?: [number, number, number, number]

    Clip box [west, south, east, north] in lon/lat (mercator maps)

    georeference?: StorymapGeoreference

    IIIF Georeference Extension placement instead of a tile source. The ground control points are fitted affinely and the image is placed on the geographic map, so this is the manifest-side equivalent of a georeferenced raster overlay.

    label?: string | (() => string)

    Control row label for the layer switcher (show_layers_control). Defaults to map_type. A function is re-invoked on every refreshLabels() for host i18n — but only when the entry comes from constructor options: mergeData() overwrites option keys with the storymap JSON, so a document carrying overlays replaces function labels with its own strings.

    locked?: boolean

    Render the row checked and disabled: an overlay the visitor may add back but not remove (e.g. a georeferenced scan the story is built on). The control never toggles a locked entry.

    map_type?: string

    Any map_type value the tile layer factory accepts. Required unless the entry carries a georeference (a placed IIIF image instead of a tile source).

    opacity?: number

    Layer opacity 0..1 (default 1)

    visible?: boolean

    Initial visibility (default true)