Class: Map

Extends

• ol.Object

Observable Properties

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

Methods

addControl(control)

src/ol/map.js, line 480

Add the given control to the map.

Name	Type	Description
control	ol.control.Control	Control.

addInteraction(interaction)

src/ol/map.js, line 492

Add the given interaction to the map.

Name	Type	Description
interaction	ol.interaction.Interaction	Interaction to add.

addLayer(layer)

src/ol/map.js, line 504

Adds the given layer to the top of this map.

Name	Type	Description
layer	ol.layer.Base	Layer.

addOverlay(overlay)

src/ol/map.js, line 515

Add the given overlay to the map.

Name	Type	Description
overlay	ol.Overlay	Overlay.

beforeRender(var_args) experimental

src/ol/map.js, line 529

Add functions to be called before rendering. This can be used for attaching animations before updating the map's view. The ol.animation namespace provides several static methods for creating prerender functions.

Name	Type	Description
var_args	ol.PreRenderFunction	Any number of pre-render functions.

bindTo(key, target, opt_targetKey){ol.ObjectAccessor} inherited experimental

src/ol/object.js, line 326

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an object with a transform method that you can use to provide from and to functions to transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );

Name	Type	Description
key	string	Key name.
target	ol.Object	Target.
targetKey	string	Target key.

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:

• change experimental

forEachFeatureAtPixel(pixel, callback, opt_this, opt_layerFilter, opt_this2){T|undefined}

src/ol/map.js, line 576

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 opt_layerFilter. Feature overlays will always be included in the detection.

Name	Type	Description
pixel	ol.Pixel	Pixel.
callback	function	Feature callback. If the detected feature is not on a layer, but on a ol.FeatureOverlay, then the 2nd argument to this function will be null. To stop detection, callback functions can return a truthy value.
this	S	Value to use as this when executing callback.
layerFilter	function	Layer filter function, 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. Feature overlays will always be tested.
this2	U	Value to use as this when executing layerFilter.

Returns:

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

forEachLayerAtPixel(pixel, callback, opt_this, opt_layerFilter, opt_this2){T|undefined}

src/ol/map.js, line 614

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. Feature overlays will always be included in the detection.

Name	Type	Description
pixel	ol.Pixel	Pixel.
callback	function	Layer callback. If the detected feature is not on a layer, but on a ol.FeatureOverlay, then the argument to this function will be null. To stop detection, callback functions can return a truthy value.
this	S	Value to use as this when executing callback.
layerFilter	function	Layer filter function, 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. Feature overlays will always be tested.
this2	U	Value to use as this when executing layerFilter.

Returns:

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

get(key){*} inherited experimental

src/ol/object.js, line 354

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getControls(){ol.Collection.<ol.control.Control>}

src/ol/map.js, line 746

Returns:

Controls.

getCoordinateFromPixel(pixel){ol.Coordinate}

src/ol/map.js, line 731

Name	Type	Description
pixel	ol.Pixel	Pixel.

Returns:

Coordinate.

getEventCoordinate(event){ol.Coordinate}

src/ol/map.js, line 663

Returns the geographical coordinate for a browser event.

Name	Type	Description
event	Event	Event.

Returns:

Coordinate.

getEventPixel(event){ol.Pixel}

src/ol/map.js, line 674

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

Name	Type	Description
event	Event	Event.

Returns:

Pixel.

getInteractions(){ol.Collection.<ol.interaction.Interaction>}

src/ol/map.js, line 769

Gets the collection of ol.interaction.Interaction instances associated with this map. 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 experimental

src/ol/object.js, line 373

Get a list of object property names.

Returns:

List of property names.

getLayerGroup(){ol.layer.Group}

src/ol/map.js, line 780

Get the layergroup associated with this map.

Returns:

A layer group containing the layers in this map.

getLayers(){ol.Collection.<ol.layer.Base>}

src/ol/map.js, line 794

Get the collection of layers associated with this map.

Returns:

Layers.

getOverlays(){ol.Collection.<ol.Overlay>}

src/ol/map.js, line 755

Returns:

Overlays.

getPixelFromCoordinate(coordinate){ol.Pixel}

src/ol/map.js, line 805

Name	Type	Description
coordinate	ol.Coordinate	Coordinate.

Returns:

Pixel.

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

src/ol/object.js, line 405

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62

Returns:

Revision.

getSize(){ol.Size|undefined}

src/ol/map.js, line 831

Get the size of this map.

Returns:

The size in pixels of the map in the DOM.

getTarget(){Element|string|undefined}

src/ol/map.js, line 703

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(){Element} experimental

src/ol/map.js, line 720

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(){ol.View}

src/ol/map.js, line 847

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

Returns:

The view that controls this map.

getViewport(){Element}

src/ol/map.js, line 860

Returns:

Viewport.

hasFeatureAtPixel(pixel, opt_layerFilter, opt_this){boolean} experimental

src/ol/map.js, line 643

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

Name	Type	Description
pixel	ol.Pixel	Pixel.
layerFilter	function	Layer filter function, 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. Feature overlays will always be tested.
this	U	Value to use as this when executing layerFilter.

Returns:

Is there a feature at the given pixel?

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 75

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.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 88

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.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener.

removeControl(control){ol.control.Control|undefined}

src/ol/map.js, line 1194

Remove the given control from the map.

Name	Type	Description
control	ol.control.Control	Control.

Returns:

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

removeInteraction(interaction){ol.interaction.Interaction|undefined}

src/ol/map.js, line 1211

Remove the given interaction from the map.

Name	Type	Description
interaction	ol.interaction.Interaction	Interaction to remove.

Returns:

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

removeLayer(layer){ol.layer.Base|undefined}

src/ol/map.js, line 1229

Removes the given layer from the map.

Name	Type	Description
layer	ol.layer.Base	Layer.

Returns:

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

removeOverlay(overlay){ol.Overlay|undefined}

src/ol/map.js, line 1242

Remove the given overlay from the map.

Name	Type	Description
overlay	ol.Overlay	Overlay.

Returns:

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

render()

src/ol/map.js, line 1180

Requests a render frame; rendering will effectively occur at the next browser animation frame.

renderSync()

src/ol/map.js, line 1170

Requests an immediate render in a synchronous manner.

set(key, value) inherited experimental

src/ol/object.js, line 437

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

setLayerGroup(layerGroup)

src/ol/map.js, line 1363

Sets the layergroup of this map.

Name	Type	Description
layerGroup	ol.layer.Group	A layer group containing the layers in this map.

setProperties(values) inherited experimental

src/ol/object.js, line 456

Sets a collection of key-value pairs.

Name	Type	Description
values	Object.<string, *>	Values.

setSize(size) experimental

src/ol/map.js, line 1378

Set the size of this map.

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

setTarget(target)

src/ol/map.js, line 1394

Set the target element to render this map into.

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

setView(view)

src/ol/map.js, line 1409

Set the view for this map.

Name	Type	Description
view	ol.View	The view that controls this map.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 101

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.
this	Object	The object which was used as this by the listener.

unbind(key) inherited experimental

src/ol/object.js, line 470

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name	Type	Description
key	string	Key name.

unbindAll() inherited experimental

src/ol/object.js, line 487

Removes all bindings.

unByKey(key) inherited

src/ol/observable.js, line 114

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name	Type	Description
key	goog.events.Key	The key returned by on() or once().

updateSize()

src/ol/map.js, line 1433

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