Returns attributions for the current content of the map.
Returns the current center of the map.
Same as olView.getCenter(), but reactive.
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.
Emitted when the map model is destroyed.
Create, receive and zoom to map highlights
The unique id of the map.
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.
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.
Returns true if the map is currently loading.
This is based on the OpenLayers events loadstart and loadend,
see Documentation.
The raw OpenLayers map.
Returns the current view of the OpenLayers map.
Create and receive map overlays
Returns the current projection of the map (reactive).
Returns the current view resolution of the map, in projection units per pixel.
Same as olView.getResolution(), but reactive.
NOTE: This is only a distance in meters if the map's projection uses meters as its unit. Use getCenterPointResolution to obtain meters per pixel for any projection.
Returns the current rotation of the map.
Same as olView.getRotation(), but reactive.
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}. The value is rounded to an integer, since it is intended for display.
Returns the OpenLayers map's viewport element.
Returns the current zoom level of the map.
Same as olView.getZoom(), but reactive.
Destroys this objects, including all layers, highlights and the OL map itself.
Returns the point resolution at the current map center, in meters per pixel.
Unlike resolution (which is in projection units per pixel), this is a real world
distance for every projection. It is derived from the current resolution, projection and
center of the map, and therefore also changes when the map is panned.
Returns undefined while the map has no resolution or center yet.
Computes the view resolution (in projection units per pixel) needed to display the map at
the given scale around the current map center.
The result can be passed to olView.setResolution(); see also setScale.
Returns undefined while the map has no center yet.
The target scale (the denominator, i.e. 1:${scale}).
OptionaltargetDpi: number
Optional pixel density, for computing a resolution for an output medium other
than the screen. Defaults to DEFAULT_DPI (~90.71), the standardized screen dpi.
Creates a highlight at the given targets.
A highlight is a temporary graphic on the map that calls attention to a point or an area.
Call destroy() on the returned highlight object to remove the highlight.
Optionaloptions: HighlightOptionsHighlight functions will be removed in a future major release; call Highlights.add instead.
Optionaloptions: HighlightZoomOptionsHighlight functions will be removed in a future major release; call Highlights.addAndZoom instead.
Removes any existing highlights from the map.
Highlight functions will be removed in a future major release; call Highlights.clear instead.
Changes the current scale of the map to the given value.
Internally, this computes the view resolution for the given scale and the current center
(see getViewResolutionForScale) and applies it to the current olView.
Reading scale afterwards returns the given value again, rounded to an integer.
Returns a promise that resolves when the map has mounted in the DOM.
Zooms to the given targets.
Optionaloptions: ZoomOptions
Represents a map.