@versatiles/map-state
    Preparing search index...

    Interface StateViewer

    How a shared or embedded map is used. What the viewer shows over the map, and where: a control at a position, or "none"; the navigation buttons at a position, each of them shown or not. Controls in the same corner are stacked. And what its viewers can do with the map: move it and zoom, unless that is switched off; rotate and tilt it, if that is switched on. Defaults in VIEWER_DEFAULTS.

    interface StateViewer {
        canPan?: boolean;
        canRotate?: boolean;
        canTilt?: boolean;
        canZoom?: boolean;
        confine?: boolean;
        fullscreen?: boolean;
        legend?:
            | "none"
            | "right"
            | "left"
            | "top"
            | "bottom"
            | "top-right"
            | "top-left"
            | "bottom-right"
            | "bottom-left";
        locate?: boolean;
        maxZoom?: number;
        minZoom?: number;
        navigation?: "top-right"
        | "top-left"
        | "bottom-right"
        | "bottom-left";
        reset?: boolean;
        scale?: "none" | "bottom-right" | "bottom-left";
        scrollZoom?: "protected" | "free";
        search?: "none" | "top-right" | "top-left";
        zoomButtons?: boolean;
    }
    Index
    canPan? canRotate? canTilt? canZoom? confine? fullscreen? legend? locate? maxZoom? minZoom? navigation? reset? scale? scrollZoom? search? zoomButtons?
    canPan?: boolean

    Viewers can move the map. Default: true.

    true
    canRotate?: boolean

    Viewers can rotate the map. Default: false.

    false
    canTilt?: boolean

    Viewers can tilt the map. Default: false.

    false
    canZoom?: boolean

    Viewers can zoom in and out. Default: true.

    true
    confine?: boolean

    Viewers stay in the area that the map shows when it opens: they cannot zoom out further, nor move the map beyond it. Default: false.

    false
    fullscreen?: boolean

    A button that shows the map on the whole screen, and back. One of the navigation buttons. An embedded map needs the permission of its page: allow="fullscreen" on its iframe. Default: false.

    false
    legend?:
        | "none"
        | "right"
        | "left"
        | "top"
        | "bottom"
        | "top-right"
        | "top-left"
        | "bottom-right"
        | "bottom-left"

    The legend, if the map has one: a side (centered) or a corner. Default: "bottom-left".

    "bottom-left"
    locate?: boolean

    A button that shows where the viewer is, if they allow it, and follows them until it is switched off. One of the navigation buttons. An embedded map needs the permission of its page: allow="geolocation" on its iframe. Default: false.

    false
    maxZoom?: number

    The largest zoom level that viewers can zoom in to, in steps of 0.5, e.g. if the map is not meant to be looked at more closely. Not less than minZoom. Default: none.

    0

    22

    0.5

    minZoom?: number

    The least zoom level that viewers can zoom out to, in steps of 0.5. What a zoom level shows depends on the size of the window, so confine is the better way to keep viewers from zooming out. Default: none.

    0

    22

    0.5

    navigation?: "top-right" | "top-left" | "bottom-right" | "bottom-left"

    The place of the navigation buttons: those for zooming, the compass, and the buttons to reset the view, for the whole screen and for the viewer's location, as far as the map has them. Default: "top-right".

    "top-right"
    reset?: boolean

    A button that shows the map as it opened: its area, its rotation and its tilt. One of the navigation buttons. Default: false.

    false
    scale?: "none" | "bottom-right" | "bottom-left"

    A bar with the length that it stands for on the map, in meters or kilometers. Default: "none".

    "none"
    scrollZoom?: "protected" | "free"

    What the wheel does over the map when it is embedded in a page: "protected" scrolls the page, and the map zooms with Ctrl (or ⌘) and the wheel, and moves on touch screens with two fingers; "free" zooms the map. A map in a window of its own is always free. Default: "protected".

    "protected"
    search?: "none" | "top-right" | "top-left"

    The address search. Default: "none".

    "none"
    zoomButtons?: boolean

    The buttons for zooming in and out, of the navigation buttons, and with them the compass of a map that its viewers can turn. Default: true.

    true

    Settings
    Member Visibility

    On This Page
    Properties