Open Pioneer Trails Packages
    Preparing search index...

    Interface MapModel

    Represents a map.

    interface MapModel {
        center: undefined | Coordinate;
        container: undefined | HTMLElement;
        id: string;
        initialExtent: undefined | ExtentConfig;
        layers: LayerCollection;
        olMap: Map;
        olView: View;
        projection: Projection;
        resolution: undefined | number;
        scale: undefined | number;
        zoomLevel: undefined | number;
        highlight(
            geometries: DisplayTarget[],
            options?: HighlightOptions,
        ): Highlight;
        highlightAndZoom(
            geometries: DisplayTarget[],
            options?: HighlightZoomOptions,
        ): Highlight;
        removeHighlights(): void;
        setScale(newScale: number): void;
        whenDisplayed(): Promise<void>;
        zoom(geometries: DisplayTarget[], options?: ZoomOptions): void;
    }

    Hierarchy

    Index

    Properties

    center container id initialExtent layers olMap olView projection resolution scale zoomLevel

    Methods

    highlight highlightAndZoom removeHighlights setScale whenDisplayed zoom

    Properties

    center: undefined | Coordinate

    Returns the current center of the map. Same as olView.getCenter(), but reactive.

    container: undefined | HTMLElement

    The container in which the map is currently being rendered. This is the same as the target element of the underlying OpenLayers map.

    May be undefined if the map is not being rendered at the moment. May change at runtime.

    id: string

    The unique id of the map.

    initialExtent: undefined | ExtentConfig

    The initial map extent.

    May be undefined before the map is shown. This is guaranteed to be initialized if the promise returned by whenDisplayed has resolved.

    layers: LayerCollection

    Contains all known layers of this map.

    Note that not all layers in this collection may be active in the OpenLayers map. Also note that not all layers in the OpenLayers map may be contained in this collection.

    olMap: Map

    The raw OpenLayers map.

    olView: View

    Returns the current view of the OpenLayers map.

    projection: Projection

    Returns the current projection of the map (reactive).

    resolution: undefined | number

    Returns the current resolution of the map. Same as olView.getResolution(), but reactive.

    scale: undefined | number

    Returns the current scale of the map.

    The scale is a value derived from the current center, resolution and projection of the map. The scale will change when the map is zoomed in our out, but depending on the projection, it may also change when the map is panned.

    NOTE: Technically, this is the denominator of the current scale. In order to display it, use a format like 1:${scale}.

    zoomLevel: undefined | number

    Returns the current zoom level of the map. Same as olView.getZoom(), but reactive.

    Methods

    • Removes any existing highlights from the map.

      Returns void

    • Changes the current scale of the map to the given value.

      Internally, this computes a new zoom level / resolution based on the scale and the current center. The new resolution is then applied to the current olView.

      See also scale.

      Parameters

      • newScale: number

      Returns void

    • Returns a promise that resolves when the map has mounted in the DOM.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods