@kayahr/etchmap
    Preparing search index...

    Interface MapOptions

    Options used when creating a map component.

    interface MapOptions {
        attributionPrefix?: string | false;
        cacheSize?: number;
        center?: Point;
        coverViewport?: boolean;
        maxConcurrentLoads?: number;
        maxZoom?: number;
        minZoom?: number;
        source?: TileSource;
        zoom?: number;
    }
    Index
    attributionPrefix? cacheSize? center? coverViewport? maxConcurrentLoads? maxZoom? minZoom? source? zoom?
    attributionPrefix?: string | false

    Trusted HTML displayed before the tile-source attribution, or false to omit it. Defaults to a linked Powered by EtchMap.

    cacheSize?: number

    Maximum positive integer number of ready tile images retained in memory. Defaults to 512.

    center?: Point

    Initial center in source coordinates. Defaults to the center of the projected tile world.

    coverViewport?: boolean

    Whether to raise the effective minimum zoom until the tile coverage fills the viewport. Defaults to true.

    Disable this to permit unused space around a map when it is displayed smaller than the viewport. Horizontal size does not constrain wrapping sources because their worlds repeat.

    maxConcurrentLoads?: number

    Maximum positive integer number of tile images loaded concurrently. Defaults to eight.

    maxZoom?: number

    Maximum continuous view zoom. Defaults to TileSource.maxZoom.

    This is independent of native tile LOD. Values above the source maximum keep scaling its maximum-level tiles up.

    minZoom?: number

    Minimum continuous view zoom. Defaults to TileSource.minZoom.

    This is independent of native tile LOD. Values below the source minimum keep scaling its minimum-level tiles down.

    source?: TileSource

    Raster-tile source. Omit to use the default OpenStreetMap source.

    zoom?: number

    Initial continuous view zoom.

    At a zoom equal to TileSource.minZoom, one source-tile pixel occupies one CSS pixel. Increasing the zoom by one doubles displayed width and height; decreasing it by one halves both dimensions. Fractional and negative values are supported. Native tile selection remains clamped to the source LOD range independently.

    When omitted, the initial zoom is one level above the effective minimum after the viewport size is known, limited by maxZoom.

    Settings
    Member Visibility

    On This Page
    Properties