Class: PluggableMap

Subclasses

• module:ol/Map~Map

Extends

• module:ol/Object~BaseObject

Observable Properties

Name	Type	Settable	ol/Object.ObjectEvent type	Description
layerGroup	module:ol/layer/Group~LayerGroup	yes	change:layergroup	A layer group containing the layers in this map.
size	module:ol/size~Size | undefined	yes	change:size	The size in pixels of the map in the DOM.
target	HTMLElement | string | undefined	yes	change:target	The Element or id of the Element that the map is rendered in.
view	module:ol/View~View	yes	change:view	The view that controls this map.

Methods

addControl(control)

PluggableMap.js, line 544

Add the given control to the map.

Name	Type	Description
control	module:ol/control/Control~Control	Control.

addInteraction(interaction)

PluggableMap.js, line 557

Add the given interaction to the map. If you want to add an interaction at another point of the collection use getInteractions() and the methods available on module:ol/Collection~Collection. This can be used to stop the event propagation from the handleEvent function. The interactions get to handle the events in the reverse order of this collection.

Name	Type	Description
interaction	module:ol/interaction/Interaction~Interaction	Interaction to add.

addLayer(layer)

PluggableMap.js, line 568

Adds the given layer to the top of this map. If you want to add a layer elsewhere in the stack, use getLayers() and the methods available on module:ol/Collection~Collection.

Name	Type	Description
layer	module:ol/layer/Base~BaseLayer	Layer.

addOverlay(overlay)

PluggableMap.js, line 586

Add the given overlay to the map.

Name	Type	Description
overlay	module:ol/Overlay~Overlay	Overlay.

changed() inherited

Observable.js, line 68

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
event	module:ol/events/Event~BaseEvent | string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

forEachFeatureAtPixel(pixel, callback, opt_options){T|undefined}

PluggableMap.js, line 633

Detect features that intersect a pixel on the viewport, and execute a callback with each intersecting feature. Layers included in the detection can be configured through the layerFilter option in opt_options.

Name	Type	Description
pixel	module:ol/pixel~Pixel	Pixel.
callback	function	Feature callback. The callback will be called with two arguments. The first argument is one feature or render feature at the pixel, the second is the layer of the feature and will be null for unmanaged layers. To stop detection, callback functions can return a truthy value.
options	Optional options. Name Type Description layerFilter undefined | function Layer filter function. The filter function will receive one argument, the layer-candidate and it should return a boolean value. Only layers which are visible and for which this function returns true will be tested for features. By default, all visible layers will be tested. hitTolerance number (defaults to 0) Hit-detection tolerance in css pixels. Pixels inside the radius around the given position will be checked for features. checkWrapped boolean (defaults to true) Check-Wrapped Will check for for wrapped geometries inside the range of +/- 1 world width. Works only if a projection is used that can be wrapped.

Returns:

Callback result, i.e. the return value of last callback execution, or the first truthy callback return value.

forEachLayerAtPixel(pixel, callback, opt_options){T|undefined}

PluggableMap.js, line 724

Please the layer.getData() method for tile layers or image layers instead of using this method.

Detect layers that have a color value at a pixel on the viewport, and execute a callback with each matching layer. Layers included in the detection can be configured through opt_layerFilter.

Note: In maps with more than one layer, this method will typically return pixel data representing the composed image of all layers visible at the given pixel – because layers will generally share the same rendering context. To force layers to render separately, and to get pixel data representing only one layer at a time, you can assign each layer a unique className in its constructor.

Name	Type	Description
pixel	module:ol/pixel~Pixel	Pixel.
callback	function	Layer callback. This callback will receive two arguments: first is the layer, second argument is an array representing [R, G, B, A] pixel values (0 - 255) and will be null for layer types that do not currently support this argument. To stop detection, callback functions can return a truthy value.
options	Configuration options. Name Type Description layerFilter undefined | function Layer filter function. The filter function will receive one argument, the layer-candidate and it should return a boolean value. Only layers which are visible and for which this function returns true will be tested for features. By default, all visible layers will be tested. hitTolerance number (defaults to 0) Hit-detection tolerance in css pixels. Pixels inside the radius around the given position will be checked for features. checkWrapped boolean (defaults to true) Check-Wrapped Will check for for wrapped geometries inside the range of +/- 1 world width. Works only if a projection is used that can be wrapped.

Deprecated

• Yes

Returns:

Callback result, i.e. the return value of last callback execution, or the first truthy callback return value.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getAllLayers(){Array.<module:ol/layer/Layer~Layer>}

PluggableMap.js, line 681

Get all layers from all layer groups.

Returns:

Layers.

getControls(){module:ol/Collection~Collection.<module:ol/control/Control~Control>}

PluggableMap.js, line 880

Get the map controls. Modifying this collection changes the controls associated with the map.

Returns:

Controls.

getCoordinateFromPixel(pixel){module:ol/coordinate~Coordinate}

PluggableMap.js, line 849

Get the coordinate for a given pixel. This returns a coordinate in the user projection.

Name	Type	Description
pixel	module:ol/pixel~Pixel	Pixel position in the map viewport.

Returns:

The coordinate for the pixel position.

getEventCoordinate(event){module:ol/coordinate~Coordinate}

PluggableMap.js, line 776

Returns the coordinate in user projection for a browser event.

Name	Type	Description
event	MouseEvent	Event.

Returns:

Coordinate.

getEventPixel(event){module:ol/pixel~Pixel}

PluggableMap.js, line 795

Returns the map pixel position for a browser event relative to the viewport.

Name	Type	Description
event	UIEvent	Event.

Returns:

Pixel.

getFeaturesAtPixel(pixel, opt_options){Array.<module:ol/Feature~FeatureLike>}

PluggableMap.js, line 664

Get all features that intersect a pixel on the viewport.

Name	Type	Description
pixel	module:ol/pixel~Pixel	Pixel.
options	Optional options. Name Type Description layerFilter undefined | function Layer filter function. The filter function will receive one argument, the layer-candidate and it should return a boolean value. Only layers which are visible and for which this function returns true will be tested for features. By default, all visible layers will be tested. hitTolerance number (defaults to 0) Hit-detection tolerance in css pixels. Pixels inside the radius around the given position will be checked for features. checkWrapped boolean (defaults to true) Check-Wrapped Will check for for wrapped geometries inside the range of +/- 1 world width. Works only if a projection is used that can be wrapped.

Returns:

The detected features or an empty array if none were found.

getInteractions(){module:ol/Collection~Collection.<module:ol/interaction/Interaction~Interaction>}

PluggableMap.js, line 915

Get the map interactions. Modifying this collection changes the interactions associated with the map.

Interactions are used for e.g. pan, zoom and rotate.

Returns:

Interactions.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:

List of property names.

getLayerGroup(){module:ol/layer/Group~LayerGroup}

PluggableMap.js, line 925

Get the layergroup associated with this map.

Returns:

A layer group containing the layers in this map.

getLayers(){module:ol/Collection~Collection.<module:ol/layer/Base~BaseLayer>}

PluggableMap.js, line 951

Get the collection of layers associated with this map.

Returns:

Layers.

getOverlayById(id){module:ol/Overlay~Overlay}

PluggableMap.js, line 902

Get an overlay by its identifier (the value returned by overlay.getId()). Note that the index treats string and numeric identifiers as the same. So map.getOverlayById(2) will return an overlay with id '2' or 2.

Name	Type	Description
id	string | number	Overlay identifier.

Returns:

Overlay.

getOverlays(){module:ol/Collection~Collection.<module:ol/Overlay~Overlay>}

PluggableMap.js, line 890

Get the map overlays. Modifying this collection changes the overlays associated with the map.

Returns:

Overlays.

getPixelFromCoordinate(coordinate){module:ol/pixel~Pixel}

PluggableMap.js, line 987

Get the pixel for a coordinate. This takes a coordinate in the user projection and returns the corresponding pixel.

Name	Type	Description
coordinate	module:ol/coordinate~Coordinate	A map coordinate.

Returns:

A pixel position in the map viewport.

getProperties(){Object.<string, *>} inherited

Object.js, line 157

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited

Observable.js, line 79

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getSize(){module:ol/size~Size|undefined}

PluggableMap.js, line 1027

Get the size of this map.

Returns:

The size in pixels of the map in the DOM.

getTarget(){HTMLElement|string|undefined}

PluggableMap.js, line 818

Get the target in which this map is rendered. Note that this returns what is entered as an option or in setTarget: if that was an element, it returns an element; if a string, it returns that.

Returns:

The Element or id of the Element that the map is rendered in.

getTargetElement(){HTMLElement}

PluggableMap.js, line 831

Get the DOM element into which this map is rendered. In contrast to getTarget this method always return an Element, or null if the map has no target.

Returns:

The element that the map is rendered in.

getView(){module:ol/View~View}

PluggableMap.js, line 1040

Get the view associated with this map. A view manages properties such as center and resolution.

Returns:

The view that controls this map.

getViewport(){HTMLElement}

PluggableMap.js, line 1049

Get the element that serves as the map viewport.

Returns:

Viewport.

hasFeatureAtPixel(pixel, opt_options){boolean}

PluggableMap.js, line 749

Detect if features intersect a pixel on the viewport. Layers included in the detection can be configured through opt_layerFilter.

Name	Type	Description
pixel	module:ol/pixel~Pixel	Pixel.
options	Optional options. Name Type Description layerFilter undefined | function Layer filter function. The filter function will receive one argument, the layer-candidate and it should return a boolean value. Only layers which are visible and for which this function returns true will be tested for features. By default, all visible layers will be tested. hitTolerance number (defaults to 0) Hit-detection tolerance in css pixels. Pixels inside the radius around the given position will be checked for features. checkWrapped boolean (defaults to true) Check-Wrapped Will check for for wrapped geometries inside the range of +/- 1 world width. Works only if a projection is used that can be wrapped.

Returns:

Is there a feature at the given pixel?

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 153

Listen for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 165

Listen once for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

removeControl(control){module:ol/control/Control~Control|undefined}

PluggableMap.js, line 1449

Remove the given control from the map.

Name	Type	Description
control	module:ol/control/Control~Control	Control.

Returns:

The removed control (or undefined if the control was not found).

removeInteraction(interaction){module:ol/interaction/Interaction~Interaction|undefined}

PluggableMap.js, line 1460

Remove the given interaction from the map.

Name	Type	Description
interaction	module:ol/interaction/Interaction~Interaction	Interaction to remove.

Returns:

The removed interaction (or undefined if the interaction was not found).

removeLayer(layer){module:ol/layer/Base~BaseLayer|undefined}

PluggableMap.js, line 1471

Removes the given layer from the map.

Name	Type	Description
layer	module:ol/layer/Base~BaseLayer	Layer.

Returns:

The removed layer (or undefined if the layer was not found).

removeOverlay(overlay){module:ol/Overlay~Overlay|undefined}

PluggableMap.js, line 1491

Remove the given overlay from the map.

Name	Type	Description
overlay	module:ol/Overlay~Overlay	Overlay.

Returns:

The removed overlay (or undefined if the overlay was not found).

render()

PluggableMap.js, line 1436

Request a map rendering (at the next animation frame).

renderSync()

PluggableMap.js, line 1412

Requests an immediate render in a synchronous manner.

set(key, value, opt_silent) inherited

Object.js, line 207

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean | undefined	Update without triggering an event.

setLayerGroup(layerGroup)

PluggableMap.js, line 1616

Sets the layergroup of this map.

Name	Type	Description
layerGroup	module:ol/layer/Group~LayerGroup	A layer group containing the layers in this map.

setLayers(layers)

PluggableMap.js, line 934

Clear any existing layers and add layers to the map.

Name	Type	Description
layers	Array.<module:ol/layer/Base~BaseLayer> | module:ol/Collection~Collection.<module:ol/layer/Base~BaseLayer>	The layers to be added to the map.

setProperties(values, opt_silent) inherited

Object.js, line 227

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
values	Object.<string, *>	Values.
silent	boolean | undefined	Update without triggering an event.

setSize(size)

PluggableMap.js, line 1630

Set the size of this map.

Name	Type	Description
size	module:ol/size~Size | undefined	The size in pixels of the map in the DOM.

setTarget(target)

PluggableMap.js, line 1641

Set the target element to render this map into.

Name	Type	Description
target	HTMLElement | string | undefined	The Element or id of the Element that the map is rendered in.

setView(view)

PluggableMap.js, line 1654

Set the view for this map.

Name	Type	Description
view	module:ol/View~View | Promise.<module:ol/View~ViewOptions>	The view that controls this map. It is also possible to pass a promise that resolves to options for constructing a view. This alternative allows view properties to be resolved by sources or other components that load view-related metadata.

un(type, listener) inherited

Observable.js, line 174

Unlisten for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.

unset(key, opt_silent) inherited

Object.js, line 251

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean | undefined	Unset without triggering an event.

updateSize()

PluggableMap.js, line 1672

Force a recalculation of the map viewport size. This should be called when third-party code changes the size of the map viewport.