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

    Interface StateBackground

    The background map, as its author set it: the base map, its theme, its labels, its colors and its relief. The editor builds the map from these settings, with @versatiles/style. Missing fields have their default; the background with only defaults is not stored at all.

    interface StateBackground {
        base?: "vector" | "satellite";
        borders?: boolean;
        buildings?: "flat" | "extruded";
        colors?: StateBackgroundColors;
        font?: string;
        haloWidth?: number;
        hillshade?: boolean;
        labels?: "none" | "normal" | "fewer";
        labelSize?: number;
        labelsOnTop?: boolean;
        language?: string;
        options?: Record<string, unknown>;
        streets?: boolean;
        terrain?: boolean;
        theme?: string;
    }
    Index
    base?: "vector" | "satellite"

    The vector map of OpenStreetMap, or satellite imagery.

    "vector"
    
    borders?: boolean

    Whether the satellite map shows the borders of countries and states over the imagery. The vector map always does.

    true
    
    buildings?: "flat" | "extruded"

    The buildings of the vector map: "flat", or "extruded" to their heights, which a tilted map shows when zoomed in.

    "flat"
    

    Changes of the colors of the map.

    font?: string

    The glyph font of the labels.

    "noto_sans_regular"
    
    haloWidth?: number

    The width of the halo around the labels, in pixels. Default: 2 on the vector map, 1 over the imagery.

    0

    1000

    hillshade?: boolean

    The relief shaded: hills and mountains with light and shadow.

    false
    
    labels?: "none" | "normal" | "fewer"

    How many labels the map shows: all, fewer (with more space between them), or none.

    "normal"
    
    labelSize?: number

    The size of the labels, as a factor.

    0

    100

    1
    
    labelsOnTop?: boolean

    Draw the labels over the areas and lines of the elements, instead of under them. The labels of markers are always on top.

    false
    
    language?: string

    The language of the labels: "user" (of the browser), "local" (the local names), or a language code, e.g. "de".

    "user"
    
    options?: Record<string, unknown>

    Options of @versatiles/style for what the settings cannot say, e.g. { "features": { "terrain": { "exaggeration": 2 } } }: of osm() for the vector map, of satellite() for the imagery. They are laid over the options that the editor builds from the settings, so they win where both say something. The editor does not write them itself.

    streets?: boolean

    Whether the satellite map shows streets, railways and the symbols of points of interest over the imagery. The vector map always does.

    true
    
    terrain?: boolean

    The terrain raised to its heights, which a tilted map shows.

    false
    
    theme?: string

    The theme of the vector map, one of @versatiles/style, e.g. "gray" or "gray-dark".

    "colorful"