Open Pioneer Trails Packages
    Preparing search index...

    Interface SimpleMapOptions

    interface SimpleMapOptions {
        advanced?: OlMapOptions;
        baseLayers?: LayerConfig[];
        center?: { x: number; y: number };
        extent?: ExtentConfig;
        fetch?: (
            resource: URL,
            init: HttpServiceRequestInit | undefined,
        ) => Promise<Response>;
        layers?: LayerConfig[];
        mapId?: string;
        mockMapRender?: boolean;
        noInitialView?: boolean;
        noProjection?: boolean;
        projection?: string;
        returnMap?: boolean;
        showAttributions?: boolean;
        topmostLayers?: LayerConfig[];
        zoom?: number;
    }
    Index
    advanced? baseLayers? center? extent? fetch? layers? mapId? mockMapRender? noInitialView? noProjection? projection? returnMap? showAttributions? topmostLayers? zoom?
    advanced?: OlMapOptions

    Passed to the open layers map constructor.

    baseLayers?: LayerConfig[]

    Base layers for the map.

    center?: { x: number; y: number }

    Center coordinates for the map.

    extent?: ExtentConfig

    Initial extent (don't mix with center / zoom).

    fetch?: (
        resource: URL,
        init: HttpServiceRequestInit | undefined,
    ) => Promise<Response>

    Overrides fetching of network resources (such as service capabilities).

    layers?: LayerConfig[]

    Layers used by the map.

    mapId?: string

    ID of the map. Defaults to "test".

    mockMapRender?: boolean

    If true, the map is rendered in a dummy div instead of the real OpenLayers canvas. This is useful for tests that need the map's view to be initialized, but don't need to actually render the map.

    False by default.

    noInitialView?: boolean

    Disables the initial view when set to true.

    noProjection?: boolean

    Disables the default projection when set to true.

    projection?: string

    The map's projection.

    returnMap?: boolean

    Also returns the map object in the return value. True by default.

    Use false to test the async loading behavior of the registry.

    showAttributions?: boolean

    See MapConfig.showAttributions

    topmostLayers?: LayerConfig[]

    Layers that are displayed on top of all other layers.

    zoom?: number

    Zoom level of the map.

    Settings
    Member Visibility

    On This Page
    Properties