new ol.Map(options)
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Map options.
|
Fires:
-
change:layerGroup
(ol.ObjectEvent) -
change:size
(ol.ObjectEvent) -
change:target
(ol.ObjectEvent) -
change:view
(ol.ObjectEvent) -
click
(ol.MapBrowserEvent) - A click with no dragging. A double click will fire two of this. -
dblclick
(ol.MapBrowserEvent) - A true double click, with no dragging. -
moveend
(ol.MapEvent) - Triggered after the map is moved. -
pointerdrag
(ol.MapBrowserEvent) experimental - Triggered when a pointer is dragged. -
pointermove
(ol.MapBrowserEvent) - Triggered when a pointer is moved. Note that on touch devices this is triggered when the map is panned, so is not the same as mousemove. -
postcompose
(ol.render.Event) experimental -
postrender
(ol.MapEvent) experimental - Triggered after a map frame is rendered. -
precompose
(ol.render.Event) experimental -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed. -
singleclick
(ol.MapBrowserEvent) - A true single click with no dragging and no double click. Note that this event is delayed by 250 ms to ensure that it is not a double click.
Subclasses
Extends
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 494 -
Add the given control to the map.
Name Type Description control
ol.control.Control Control.
-
addInteraction(interaction)
src/ol/map.js, line 506 -
Add the given interaction to the map.
Name Type Description interaction
ol.interaction.Interaction Interaction to add.
-
addLayer(layer)
src/ol/map.js, line 521 -
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 onol.Collection
.Name Type Description layer
ol.layer.Base Layer.
-
addOverlay(overlay)
src/ol/map.js, line 532 -
Add the given overlay to the map.
Name Type Description overlay
ol.Overlay Overlay.
-
beforeRender(var_args) experimental
src/ol/map.js, line 546 -
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.
-
changed() inherited experimental
src/ol/observable.js, line 52 -
Increases the revision counter and dispatches a 'change' event.
Fires:
-
change
experimental
-
-
forEachFeatureAtPixel(pixel, callback, opt_this, opt_layerFilter, opt_this2){T|undefined}
src/ol/map.js, line 597 -
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. The callback will be called with two arguments. The first argument is one
feature
at the pixel, the second is thelayer
of the feature. If the detected feature is not on a layer, but on aol.FeatureOverlay
, then the second argument to this function will benull
. To stop detection, callback functions can return a truthy value.this
S Value to use as
this
when executingcallback
.layerFilter
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 returnstrue
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 executinglayerFilter
.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 638 -
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. Will receive one argument, the
layer
that contains the color pixel. If the detected color value is not from a layer, but from aol.FeatureOverlay
, then the argument to this function will benull
. To stop detection, callback functions can return a truthy value.this
S Value to use as
this
when executingcallback
.layerFilter
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 returnstrue
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 executinglayerFilter
.Returns:
Callback result, i.e. the return value of last callback execution, or the first truthy callback return value.
-
get(key){*} inherited
src/ol/object.js, line 150 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getControls(){ol.Collection.<ol.control.Control>}
src/ol/map.js, line 772 -
Get the map controls. Modifying this collection changes the controls associated with the map.
Returns:
Controls.
-
getCoordinateFromPixel(pixel){ol.Coordinate}
src/ol/map.js, line 755 -
Get the coordinate for a given pixel. This returns a coordinate in the map view projection.
Name Type Description pixel
ol.Pixel Pixel position in the map viewport.
Returns:
The coordinate for the pixel position.
-
getEventCoordinate(event){ol.Coordinate}
src/ol/map.js, line 689 -
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 700 -
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 796 -
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
src/ol/object.js, line 164 -
Get a list of object property names.
Returns:
List of property names.
-
getLayerGroup(){ol.layer.Group}
src/ol/map.js, line 807 -
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 817 -
Get the collection of layers associated with this map.
Returns:
Layers.
-
getOverlays(){ol.Collection.<ol.Overlay>}
src/ol/map.js, line 783 -
Get the map overlays. Modifying this collection changes the overlays associated with the map.
Returns:
Overlays.
-
getPixelFromCoordinate(coordinate){ol.Pixel}
src/ol/map.js, line 830 -
Get the pixel for a coordinate. This takes a coordinate in the map view projection and returns the corresponding pixel.
Name Type Description coordinate
ol.Coordinate A map coordinate.
Returns:
A pixel position in the map viewport.
-
getProperties(){Object.<string, *>} inherited
src/ol/object.js, line 174 -
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 856 -
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 729 -
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 742 -
Get the DOM element into which this map is rendered. In contrast to
getTarget
this method always return anElement
, ornull
if the map has no target.Returns:
The element that the map is rendered in.
-
getView(){ol.View}
src/ol/map.js, line 868 -
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 878 -
Get the element that serves as the map viewport.
Returns:
Viewport.
-
hasFeatureAtPixel(pixel, opt_layerFilter, opt_this){boolean} experimental
src/ol/map.js, line 669 -
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. 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 returnstrue
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 executinglayerFilter
.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
inlistener
.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
inlistener
.Returns:
Unique key for the listener.
-
removeControl(control){ol.control.Control|undefined}
src/ol/map.js, line 1220 -
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 1237 -
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 1256 -
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 1269 -
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 1206 -
Request a map rendering (at the next animation frame).
-
renderSync()
src/ol/map.js, line 1197 -
Requests an immediate render in a synchronous manner.
-
set(key, value) inherited
src/ol/object.js, line 203 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setLayerGroup(layerGroup)
src/ol/map.js, line 1376 -
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
src/ol/object.js, line 216 -
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.
-
setSize(size) experimental
src/ol/map.js, line 1387 -
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 1399 -
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 1410 -
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 thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 114 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
. -
unset(key) inherited
src/ol/object.js, line 229 -
Unsets a property.
Name Type Description key
string Key name.
-
updateSize()
src/ol/map.js, line 1430 -
Force a recalculation of the map viewport size. This should be called when third-party code changes the size of the map viewport.