ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
fd8df2949b7b6341db8ff5ce96c7ab48925c7539
openlayers/wmts-hidpi/apidoc/ol.Map.html
T
Andreas Hocevar 1e25fc5585 Update wmts-hidpi, add nicer-api-docs
2014-05-06 13:02:46 -05:00

6119 lines
84 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers 3 API Documentation - Class: ol.Map</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link rel="stylesheet" href="../resources/bootstrap/css/bootstrap.min.css" type="text/css">
<link rel="stylesheet" href="../resources/layout.css" type="text/css">
<link rel="stylesheet" href="../resources/bootstrap/css/bootstrap-responsive.min.css" type="text/css">
<link type="text/css" rel="stylesheet" href="styles/ol.css">
</head>
<body>
<div class="navbar navbar-inverse navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="/"><img src="../resources/logo.png"> OpenLayers 3</a>
</div>
</div>
</div>
<div id="main">
<section>
<header>
<h2>
<span class="ancestors"><a href="ol.html">ol</a>.</span>
ol.Map
</h2>
<div class="class-description"><p>The map is the core component of OpenLayers. In its minimal configuration it
needs a view, one or more layers, and a target container:</p>
<pre><code>var map = new ol.Map({
view: new ol.View2D({
center: [0, 0],
zoom: 1
}),
layers: [
new ol.layer.Tile({
source: new ol.source.MapQuestOSM()
})
],
target: 'map'
});
</code></pre><p>The above snippet creates a map with a MapQuest OSM layer on a 2D view and
renders it to a DOM element with the id <code>map</code>.</p></div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Map"><span class="type-signature"></span>new Map</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><a href="olx.html#MapOptions">olx.MapOptions</a></span>
</td>
<td class="description last"><p>Map options.</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>controls</code></td>
<td class="type">
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
|
<span class="param-type">Array.&lt;<a href="ol.control.Control.html">ol.control.Control</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Controls initially added to the map.</p></td>
</tr>
<tr>
<td class="name"><code>deviceOptions</code></td>
<td class="type">
<span class="param-type"><a href="olx.html#DeviceOptions">olx.DeviceOptions</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Device options for the map.</p></td>
</tr>
<tr>
<td class="name"><code>pixelRatio</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The ratio between physical pixels and device-independent pixels (dips) on the
device. If <code>undefined</code> then it gets set by using <code>window.devicePixelRatio</code>.</p></td>
</tr>
<tr>
<td class="name"><code>interactions</code></td>
<td class="type">
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
|
<span class="param-type">Array.&lt;ol.interaction.Interaction></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Interactions that are initially added to the map.</p></td>
</tr>
<tr>
<td class="name"><code>keyboardEventTarget</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">Document</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The element to listen to keyboard events on. This determines when the
<code>KeyboardPan</code> and <code>KeyboardZoom</code> interactions trigger. For example, if this
option is set to <code>document</code> the keyboard interactions will always trigger. If
this option is not specified, the element the library listens to keyboard
events on is the map target (i.e. the user-provided div for the map). If this
is not <code>document</code> the target element needs to be focused for key events to be
emitted, requiring that the target element has a <code>tabindex</code> attribute.</p></td>
</tr>
<tr>
<td class="name"><code>layers</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.layer.Base.html">ol.layer.Base</a>></span>
|
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Layers. Array or <a href="ol.Collection.html">ol.Collection</a> items are instances of
<a href="ol.layer.Layer.html">ol.layer.Layer</a> or any of its <a href="ol.layer.html">ol.layer</a> subclasses.</p></td>
</tr>
<tr>
<td class="name"><code>ol3Logo</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Show ol3 logo. Default is <code>true</code>.</p></td>
</tr>
<tr>
<td class="name"><code>overlays</code></td>
<td class="type">
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
|
<span class="param-type">Array.&lt;<a href="ol.Overlay.html">ol.Overlay</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Overlays initially added to the map.</p></td>
</tr>
<tr>
<td class="name"><code>renderer</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#RendererHint">ol.RendererHint</a></span>
|
<span class="param-type">Array.&lt;(<a href="ol.html#RendererHint">ol.RendererHint</a>|string)></span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Renderer.</p></td>
</tr>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The container for the map.</p></td>
</tr>
<tr>
<td class="name"><code>view</code></td>
<td class="type">
<span class="param-type">ol.IView</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The map's view. Currently <a href="ol.View2D.html">ol.View2D</a> is available as view.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 170</li></ul></dd>
</dl>
<h5>Fires:</h5>
<ul>
<li>
<a href="ol.MapBrowserEvent.html">ol.MapBrowserEvent</a> ol.event:MapBrowserEvent
</li>
<li>
<a href="ol.MapEvent.html">ol.MapEvent</a> ol.event:MapEvent
</li>
<li>
<a href="ol.render.Event.html">ol.render.Event</a> ol.render.event:Event
</li>
<li>
<a href="ol.ObjectEvent.html">ol.ObjectEvent</a> ol.event:ObjectEvent
</li>
</ul>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="ol.Object.html">ol.Object</a>
</li>
</ul>
<h3 class="subsection-title">Observable Properties</h3>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Settable</th>
<th><a href="ol.ObjectEvent.html">ol.ObjectEvent</a> type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layergroup</code></td>
<td class="type">
<span class="param-type"><a href="ol.layer.Group.html">ol.layer.Group</a></span>
</td>
<td class="setter">yes</td>
<td class="event"><code>change:layergroup</code></td>
<td class="description last">a layer group containing the
layers in this map.</td>
</tr>
<tr>
<td class="name"><code>size</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#Size">ol.Size</a></span>
</td>
<td class="setter">yes</td>
<td class="event"><code>change:size</code></td>
<td class="description last">the size in pixels of the map in the DOM</td>
</tr>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">Element</span>
</td>
<td class="setter">yes</td>
<td class="event"><code>change:target</code></td>
<td class="description last">the Element or id of the Element
that the map is rendered in.</td>
</tr>
<tr>
<td class="name"><code>view</code></td>
<td class="type">
<span class="param-type">ol.IView</span>
</td>
<td class="setter">yes</td>
<td class="event"><code>change:view</code></td>
<td class="description last">the view that controls this map</td>
</tr>
</tbody>
</table>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="addControl"><span class="type-signature"></span>addControl</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Add the given control to the map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>control</code></td>
<td class="type">
<span class="param-type"><a href="ol.control.Control.html">ol.control.Control</a></span>
</td>
<td class="description last"><p>Control.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 471</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="addInteraction"><span class="type-signature"></span>addInteraction</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Add the given interaction to the map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interaction</code></td>
<td class="type">
<span class="param-type">ol.interaction.Interaction</span>
</td>
<td class="description last"><p>Interaction to add.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 483</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="addLayer"><span class="type-signature"></span>addLayer</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Adds the given layer to the top of this map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ol.layer.Base.html">ol.layer.Base</a></span>
</td>
<td class="description last"><p>Layer.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 495</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="addOverlay"><span class="type-signature"></span>addOverlay</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Add the given overlay to the map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>overlay</code></td>
<td class="type">
<span class="param-type"><a href="ol.Overlay.html">ol.Overlay</a></span>
</td>
<td class="description last"><p>Overlay.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 507</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="beforeRender"><span class="type-signature"></span>beforeRender</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Add functions to be called before rendering. This can be used for attaching
animations before updating the map's view. The <a href="ol.animation.html">ol.animation</a>
namespace provides several static methods for creating prerender functions.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>var_args</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#PreRenderFunction">ol.PreRenderFunction</a></span>
</td>
<td class="description last"><p>Any number of pre-render functions.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 521</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="bindTo"><span class="type-signature"></span>bindTo</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>The bindTo method allows you to set up a two-way binding between a
<code>source</code> and <code>target</code> object. The method returns an
ol.ObjectAccessor with a transform method that lets you transform
values on the way from the source to the target and on the way back.</p>
<p>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:</p>
<pre><code>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;
}
);
</code></pre>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Key name.</p></td>
</tr>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type"><a href="ol.Object.html">ol.Object</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Target.</p></td>
</tr>
<tr>
<td class="name"><code>targetKey</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Target key.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#bindTo">ol.Object#bindTo</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 247</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ol.ObjectAccessor</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="dispatchChangeEvent"><span class="type-signature"></span>dispatchChangeEvent</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Dispatches a <code>change</code> event. Register a listener for this event to get
notified of changes.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Observable.html#dispatchChangeEvent">ol.Observable#dispatchChangeEvent</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>observable.js, line 39</li></ul></dd>
</dl>
<h5>Fires:</h5>
<ul>
<li>
event:change
</li>
</ul>
</dd>
<dt>
<h4 class="name" id="forEachFeatureAtPixel"><span class="type-signature"></span>forEachFeatureAtPixel</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pixel</code></td>
<td class="type">
<span class="param-type">ol.Pixel</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Pixel.</p></td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Feature
callback.</p></td>
</tr>
<tr>
<td class="name"><code>this</code></td>
<td class="type">
<span class="param-type">S</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Value to use as <code>this</code> when executing <code>callback</code>.</p></td>
</tr>
<tr>
<td class="name"><code>layerFilter</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Layer
filter function, only layers which are visible and for which this
function returns <code>true</code> will be tested for features. By default, all
visible layers will be tested.</p></td>
</tr>
<tr>
<td class="name"><code>this2</code></td>
<td class="type">
<span class="param-type">U</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Value to use as <code>this</code> when executing <code>layerFilter</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 560</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Callback result.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">T</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="get"><span class="type-signature"></span>get</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Gets a value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key name.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#get">ol.Object#get</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 304</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Value.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getControls"><span class="type-signature"></span>getControls</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 650</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Controls.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCoordinateFromPixel"><span class="type-signature"></span>getCoordinateFromPixel</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pixel</code></td>
<td class="type">
<span class="param-type">ol.Pixel</span>
</td>
<td class="description last"><p>Pixel.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 635</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Coordinate.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.html#Coordinate">ol.Coordinate</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getEventCoordinate"><span class="type-signature"></span>getEventCoordinate</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Returns the geographical coordinate for a browser event.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">Event</span>
</td>
<td class="description last"><p>Event.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 582</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Coordinate.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.html#Coordinate">ol.Coordinate</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getEventPixel"><span class="type-signature"></span>getEventPixel</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Returns the map pixel position for a browser event.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">Event</span>
</td>
<td class="description last"><p>Event.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 593</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Pixel.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ol.Pixel</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getInteractions"><span class="type-signature"></span>getInteractions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Gets the collection of
<a href="ol.interaction.html">ol.interaction.Interaction</a> instances
associated with this map. Modifying this collection
changes the interactions associated with the map.</p>
<p>Interactions are used for e.g. pan, zoom and rotate.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 674</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Interactions.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getKeys"><span class="type-signature"></span>getKeys</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get a list of object property names.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#getKeys">ol.Object#getKeys</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 332</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>List of property names.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;string></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getLayerGroup"><span class="type-signature"></span>getLayerGroup</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the layergroup associated with this map.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 684</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>LayerGroup.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.layer.Group.html">ol.layer.Group</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getLayers"><span class="type-signature"></span>getLayers</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the collection of layers associated with this map.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 699</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Layers.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getOverlays"><span class="type-signature"></span>getOverlays</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 659</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Overlays.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getPixelFromCoordinate"><span class="type-signature"></span>getPixelFromCoordinate</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>coordinate</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#Coordinate">ol.Coordinate</a></span>
</td>
<td class="description last"><p>Coordinate.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 714</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Pixel.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ol.Pixel</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getProperties"><span class="type-signature"></span>getProperties</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get an object of all property names and values.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#getProperties">ol.Object#getProperties</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 364</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Object.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object.&lt;string, *></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getSize"><span class="type-signature"></span>getSize</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the size of this map.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 730</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Size.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.html#Size">ol.Size</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTarget"><span class="type-signature"></span>getTarget</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>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.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 620</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Target.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Element</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getView"><span class="type-signature"></span>getView</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the view associated with this map. This can be a 2D or 3D view. A 2D
view manages properties such as center and resolution.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 745</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>View.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ol.View</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getViewport"><span class="type-signature"></span>getViewport</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 758</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Viewport.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Element</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="notify"><span class="type-signature"></span>notify</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Notify all observers of a change on this property. This notifies both
objects that are bound to the object's property as well as the object
that it is bound to.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key name.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#notify">ol.Object#notify</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 384</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="on"><span class="type-signature"></span>on</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Listen for a certain type of event.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">Array.&lt;string></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The event type or array of event types.</p></td>
</tr>
<tr>
<td class="name"><code>listener</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The listener function.</p></td>
</tr>
<tr>
<td class="name"><code>this</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The object to use as <code>this</code> in <code>listener</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Observable.html#on">ol.Observable#on</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>observable.js, line 61</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Unique key for the listener.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">goog.events.Key</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="once"><span class="type-signature"></span>once</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Listen once for a certain type of event.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">Array.&lt;string></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The event type or array of event types.</p></td>
</tr>
<tr>
<td class="name"><code>listener</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The listener function.</p></td>
</tr>
<tr>
<td class="name"><code>this</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The object to use as <code>this</code> in <code>listener</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Observable.html#once">ol.Observable#once</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>observable.js, line 74</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Unique key for the listener.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">goog.events.Key</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeControl"><span class="type-signature"></span>removeControl</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Remove the given control from the map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>control</code></td>
<td class="type">
<span class="param-type"><a href="ol.control.Control.html">ol.control.Control</a></span>
</td>
<td class="description last"><p>Control.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1091</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The removed control of undefined
if the control was not found.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.control.Control.html">ol.control.Control</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeInteraction"><span class="type-signature"></span>removeInteraction</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Remove the given interaction from the map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interaction</code></td>
<td class="type">
<span class="param-type">ol.interaction.Interaction</span>
</td>
<td class="description last"><p>Interaction to remove.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1108</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The removed interaction (or
undefined if the interaction was not found).</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">ol.interaction.Interaction</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeLayer"><span class="type-signature"></span>removeLayer</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Removes the given layer from the map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type"><a href="ol.layer.Base.html">ol.layer.Base</a></span>
</td>
<td class="description last"><p>Layer.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1126</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The removed layer or undefined if the
layer was not found.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.layer.Base.html">ol.layer.Base</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeOverlay"><span class="type-signature"></span>removeOverlay</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Remove the given overlay from the map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>overlay</code></td>
<td class="type">
<span class="param-type"><a href="ol.Overlay.html">ol.Overlay</a></span>
</td>
<td class="description last"><p>Overlay.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1140</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The removed overlay of undefined
if the overlay was not found.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Overlay.html">ol.Overlay</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="render"><span class="type-signature"></span>render</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Request that renderFrame_ be called some time in the future.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1077</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="renderSync"><span class="type-signature"></span>renderSync</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Render.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1068</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="set"><span class="type-signature"></span>set</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Sets a value.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key name.</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"><p>Value.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#set">ol.Object#set</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 415</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setLayerGroup"><span class="type-signature"></span>setLayerGroup</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Sets the layergroup of this map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>layerGroup</code></td>
<td class="type">
<span class="param-type"><a href="ol.layer.Group.html">ol.layer.Group</a></span>
</td>
<td class="description last"><p>Layergroup.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1262</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setSize"><span class="type-signature"></span>setSize</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Set the size of this map.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>size</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#Size">ol.Size</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Size.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1276</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setTarget"><span class="type-signature"></span>setTarget</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Set the target element to render this map into.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Target.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1290</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setValues"><span class="type-signature"></span>setValues</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Sets a collection of key-value pairs.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>values</code></td>
<td class="type">
<span class="param-type">Object.&lt;string, *></span>
</td>
<td class="description last"><p>Values.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#setValues">ol.Object#setValues</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 444</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setView"><span class="type-signature"></span>setView</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Set the view for this map. Currently <a href="ol.View2D.html">ol.View2D</a> is implememnted.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>view</code></td>
<td class="type">
<span class="param-type">ol.IView</span>
</td>
<td class="description last"><p>View.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1304</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="un"><span class="type-signature"></span>un</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Unlisten for a certain type of event.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">Array.&lt;string></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The event type or array of event types.</p></td>
</tr>
<tr>
<td class="name"><code>listener</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The listener function.</p></td>
</tr>
<tr>
<td class="name"><code>this</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The object to use as <code>this</code> in <code>listener</code>.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Observable.html#un">ol.Observable#un</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>observable.js, line 86</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="unbind"><span class="type-signature"></span>unbind</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>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.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Key name.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#unbind">ol.Object#unbind</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 458</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="unbindAll"><span class="type-signature"></span>unbindAll</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Removes all bindings.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#unbindAll">ol.Object#unbindAll</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 482</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="unByKey"><span class="type-signature"></span>unByKey</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Removes an event listener using the key returned by <code>on()</code> or <code>once()</code>.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">goog.events.Key</span>
</td>
<td class="description last"><p>Key.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Observable.html#unByKey">ol.Observable#unByKey</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>observable.js, line 96</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="updateSize"><span class="type-signature"></span>updateSize</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Force a recalculation of the map viewport size. This should be called when
third-party code changes the size of the map viewport.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 1328</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="ol.Attribution.html">ol.Attribution</a></li><li><a href="ol.Collection.html">ol.Collection</a></li><li><a href="ol.CollectionEvent.html">ol.CollectionEvent</a></li><li><a href="ol.DeviceOrientation.html">ol.DeviceOrientation</a></li><li><a href="ol.DragBoxEvent.html">ol.DragBoxEvent</a></li><li><a href="ol.DrawEvent.html">ol.DrawEvent</a></li><li><a href="ol.Feature.html">ol.Feature</a></li><li><a href="ol.FeatureOverlay.html">ol.FeatureOverlay</a></li><li><a href="ol.Geolocation.html">ol.Geolocation</a></li><li><a href="ol.ImageTile.html">ol.ImageTile</a></li><li><a href="ol.Kinetic.html">ol.Kinetic</a></li><li><a href="ol.Map.html">ol.Map</a></li><li><a href="ol.MapBrowserEvent.html">ol.MapBrowserEvent</a></li><li><a href="ol.MapEvent.html">ol.MapEvent</a></li><li><a href="ol.Object.html">ol.Object</a></li><li><a href="ol.ObjectEvent.html">ol.ObjectEvent</a></li><li><a href="ol.Observable.html">ol.Observable</a></li><li><a href="ol.Overlay.html">ol.Overlay</a></li><li><a href="ol.Tile.html">ol.Tile</a></li><li><a href="ol.TileCoord.html">ol.TileCoord</a></li><li><a href="ol.View2D.html">ol.View2D</a></li><li><a href="ol.control.Attribution.html">ol.control.Attribution</a></li><li><a href="ol.control.Control.html">ol.control.Control</a></li><li><a href="ol.control.FullScreen.html">ol.control.FullScreen</a></li><li><a href="ol.control.Logo.html">ol.control.Logo</a></li><li><a href="ol.control.MousePosition.html">ol.control.MousePosition</a></li><li><a href="ol.control.Rotate.html">ol.control.Rotate</a></li><li><a href="ol.control.ScaleLine.html">ol.control.ScaleLine</a></li><li><a href="ol.control.Zoom.html">ol.control.Zoom</a></li><li><a href="ol.control.ZoomSlider.html">ol.control.ZoomSlider</a></li><li><a href="ol.control.ZoomToExtent.html">ol.control.ZoomToExtent</a></li><li><a href="ol.dom.Input.html">ol.dom.Input</a></li><li><a href="ol.format.GPX.html">ol.format.GPX</a></li><li><a href="ol.format.GeoJSON.html">ol.format.GeoJSON</a></li><li><a href="ol.format.IGC.html">ol.format.IGC</a></li><li><a href="ol.format.KML.html">ol.format.KML</a></li><li><a href="ol.format.OSMXML.html">ol.format.OSMXML</a></li><li><a href="ol.format.TopoJSON.html">ol.format.TopoJSON</a></li><li><a href="ol.format.WFS.html">ol.format.WFS</a></li><li><a href="ol.format.WMSCapabilities.html">ol.format.WMSCapabilities</a></li><li><a href="ol.geom.Circle.html">ol.geom.Circle</a></li><li><a href="ol.geom.Geometry.html">ol.geom.Geometry</a></li><li><a href="ol.geom.GeometryCollection.html">ol.geom.GeometryCollection</a></li><li><a href="ol.geom.LineString.html">ol.geom.LineString</a></li><li><a href="ol.geom.LinearRing.html">ol.geom.LinearRing</a></li><li><a href="ol.geom.MultiLineString.html">ol.geom.MultiLineString</a></li><li><a href="ol.geom.MultiPoint.html">ol.geom.MultiPoint</a></li><li><a href="ol.geom.MultiPolygon.html">ol.geom.MultiPolygon</a></li><li><a href="ol.geom.Point.html">ol.geom.Point</a></li><li><a href="ol.geom.Polygon.html">ol.geom.Polygon</a></li><li><a href="ol.geom.SimpleGeometry.html">ol.geom.SimpleGeometry</a></li><li><a href="ol.interaction.DoubleClickZoom.html">ol.interaction.DoubleClickZoom</a></li><li><a href="ol.interaction.DragAndDrop.html">ol.interaction.DragAndDrop</a></li><li><a href="ol.interaction.DragAndDropEvent.html">ol.interaction.DragAndDropEvent</a></li><li><a href="ol.interaction.DragBox.html">ol.interaction.DragBox</a></li><li><a href="ol.interaction.DragPan.html">ol.interaction.DragPan</a></li><li><a href="ol.interaction.DragRotate.html">ol.interaction.DragRotate</a></li><li><a href="ol.interaction.DragRotateAndZoom.html">ol.interaction.DragRotateAndZoom</a></li><li><a href="ol.interaction.DragZoom.html">ol.interaction.DragZoom</a></li><li><a href="ol.interaction.Draw.html">ol.interaction.Draw</a></li><li><a href="ol.interaction.KeyboardPan.html">ol.interaction.KeyboardPan</a></li><li><a href="ol.interaction.KeyboardZoom.html">ol.interaction.KeyboardZoom</a></li><li><a href="ol.interaction.Modify.html">ol.interaction.Modify</a></li><li><a href="ol.interaction.MouseWheelZoom.html">ol.interaction.MouseWheelZoom</a></li><li><a href="ol.interaction.PinchRotate.html">ol.interaction.PinchRotate</a></li><li><a href="ol.interaction.PinchZoom.html">ol.interaction.PinchZoom</a></li><li><a href="ol.interaction.Select.html">ol.interaction.Select</a></li><li><a href="ol.layer.Base.html">ol.layer.Base</a></li><li><a href="ol.layer.Group.html">ol.layer.Group</a></li><li><a href="ol.layer.Heatmap.html">ol.layer.Heatmap</a></li><li><a href="ol.layer.Image.html">ol.layer.Image</a></li><li><a href="ol.layer.Layer.html">ol.layer.Layer</a></li><li><a href="ol.layer.Tile.html">ol.layer.Tile</a></li><li><a href="ol.layer.Vector.html">ol.layer.Vector</a></li><li><a href="ol.proj.CH.html">ol.proj.CH</a></li><li><a href="ol.proj.EPSG2056.html">ol.proj.EPSG2056</a></li><li><a href="ol.proj.EPSG21781.html">ol.proj.EPSG21781</a></li><li><a href="ol.proj.EPSG3857.html">ol.proj.EPSG3857</a></li><li><a href="ol.proj.EPSG4326.html">ol.proj.EPSG4326</a></li><li><a href="ol.proj.Projection.html">ol.proj.Projection</a></li><li><a href="ol.render.Event.html">ol.render.Event</a></li><li><a href="ol.render.canvas.Immediate.html">ol.render.canvas.Immediate</a></li><li><a href="ol.source.BingMaps.html">ol.source.BingMaps</a></li><li><a href="ol.source.GPX.html">ol.source.GPX</a></li><li><a href="ol.source.GeoJSON.html">ol.source.GeoJSON</a></li><li><a href="ol.source.IGC.html">ol.source.IGC</a></li><li><a href="ol.source.ImageCanvas.html">ol.source.ImageCanvas</a></li><li><a href="ol.source.ImageStatic.html">ol.source.ImageStatic</a></li><li><a href="ol.source.ImageVector.html">ol.source.ImageVector</a></li><li><a href="ol.source.ImageWMS.html">ol.source.ImageWMS</a></li><li><a href="ol.source.KML.html">ol.source.KML</a></li><li><a href="ol.source.MapGuide.html">ol.source.MapGuide</a></li><li><a href="ol.source.MapQuest.html">ol.source.MapQuest</a></li><li><a href="ol.source.OSM.html">ol.source.OSM</a></li><li><a href="ol.source.OSMXML.html">ol.source.OSMXML</a></li><li><a href="ol.source.ServerVector.html">ol.source.ServerVector</a></li><li><a href="ol.source.Source.html">ol.source.Source</a></li><li><a href="ol.source.Stamen.html">ol.source.Stamen</a></li><li><a href="ol.source.StaticVector.html">ol.source.StaticVector</a></li><li><a href="ol.source.Tile.html">ol.source.Tile</a></li><li><a href="ol.source.TileDebug.html">ol.source.TileDebug</a></li><li><a href="ol.source.TileImage.html">ol.source.TileImage</a></li><li><a href="ol.source.TileJSON.html">ol.source.TileJSON</a></li><li><a href="ol.source.TileVector.html">ol.source.TileVector</a></li><li><a href="ol.source.TileWMS.html">ol.source.TileWMS</a></li><li><a href="ol.source.TopoJSON.html">ol.source.TopoJSON</a></li><li><a href="ol.source.Vector.html">ol.source.Vector</a></li><li><a href="ol.source.VectorEvent.html">ol.source.VectorEvent</a></li><li><a href="ol.source.WMTS.html">ol.source.WMTS</a></li><li><a href="ol.source.XYZ.html">ol.source.XYZ</a></li><li><a href="ol.source.Zoomify.html">ol.source.Zoomify</a></li><li><a href="ol.style.Circle.html">ol.style.Circle</a></li><li><a href="ol.style.Fill.html">ol.style.Fill</a></li><li><a href="ol.style.Icon.html">ol.style.Icon</a></li><li><a href="ol.style.Image.html">ol.style.Image</a></li><li><a href="ol.style.Stroke.html">ol.style.Stroke</a></li><li><a href="ol.style.Style.html">ol.style.Style</a></li><li><a href="ol.style.Text.html">ol.style.Text</a></li><li><a href="ol.tilegrid.TileGrid.html">ol.tilegrid.TileGrid</a></li><li><a href="ol.tilegrid.WMTS.html">ol.tilegrid.WMTS</a></li><li><a href="ol.tilegrid.XYZ.html">ol.tilegrid.XYZ</a></li><li><a href="ol.tilegrid.Zoomify.html">ol.tilegrid.Zoomify</a></li><li><a href="ol.webgl.Context.html">ol.webgl.Context</a></li><li><a href="oli.CollectionEvent.html">oli.CollectionEvent</a></li><li><a href="oli.DragBoxEvent.html">oli.DragBoxEvent</a></li><li><a href="oli.DrawEvent.html">oli.DrawEvent</a></li><li><a href="oli.FrameState.html">oli.FrameState</a></li><li><a href="oli.MapBrowserEvent.html">oli.MapBrowserEvent</a></li><li><a href="oli.interaction.DragAndDropEvent.html">oli.interaction.DragAndDropEvent</a></li><li><a href="oli.render.Event.html">oli.render.Event</a></li><li><a href="oli.source.VectorEvent.html">oli.source.VectorEvent</a></li></ul><h3>Namespaces</h3><ul><li><a href="ol.html">ol</a></li><li><a href="ol.BrowserFeature.html">ol.BrowserFeature</a></li><li><a href="ol.animation.html">ol.animation</a></li><li><a href="ol.control.html">ol.control</a></li><li><a href="ol.events.condition.html">ol.events.condition</a></li><li><a href="ol.feature_.html">ol.feature</a></li><li><a href="ol.geom.html">ol.geom</a></li><li><a href="ol.interaction.html">ol.interaction</a></li><li><a href="ol.layer.html">ol.layer</a></li><li><a href="ol.proj.html">ol.proj</a></li><li><a href="ol.render.html">ol.render</a></li><li><a href="ol.render.canvas.html">ol.render.canvas</a></li><li><a href="ol.source.html">ol.source</a></li><li><a href="ol.tilegrid.html">ol.tilegrid</a></li><li><a href="oli.html">oli</a></li><li><a href="olx.html">olx</a></li><li><a href="olx.animation.html">olx.animation</a></li><li><a href="olx.control.html">olx.control</a></li><li><a href="olx.format.html">olx.format</a></li><li><a href="olx.interaction.html">olx.interaction</a></li><li><a href="olx.layer.html">olx.layer</a></li><li><a href="olx.parser.html">olx.parser</a></li><li><a href="olx.render.html">olx.render</a></li><li><a href="olx.source.html">olx.source</a></li><li><a href="olx.style.html">olx.style</a></li><li><a href="olx.tilegrid.html">olx.tilegrid</a></li></ul><h3>Global</h3><ul></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a>
</footer>
<script> prettyPrint(); </script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink