Files
openlayers/apidoc/master/ol.Map.html
Éric Lemoine 447d9ec05b Update
2012-09-28 10:52:49 +02:00

5586 lines
59 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers 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/apidoc.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: ol.Map</h1>
<section>
<header>
<h2>
ol.Map
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Map"><span class="type-signature"></span>new Map</h4>
</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>container</code></td>
<td class="type">
<span class="param-type">Element</span>
</td>
<td class="description last">Container.</td>
</tr>
<tr>
<td class="name"><code>mapOptionsLiteral</code></td>
<td class="type">
<span class="param-type">ol.MapOptionsLiteral</span>
</td>
<td class="description last">Map options literal.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 82</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="ol.Object.html">ol.Object</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="protected">
<h4 class="name" id="changed"><span class="type-signature"></span>changed<span class="type-signature"></span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.Object.html#changed">ol.Object#changed</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 147</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="logger"><span class="type-signature">&lt;protected> </span>logger<span class="type-signature"> :goog.debug.Logger</span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 91</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="setValues"><span class="type-signature"></span>setValues<span class="type-signature"></span></h4>
</dt>
<dd class="protected">
<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 239</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="bindTo"><span class="type-signature"></span>bindTo</h4>
</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Key.</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="description last">Target.</td>
</tr>
<tr>
<td class="name"><code>targetKey</code></td>
<td class="type">
<span class="param-type">string=</span>
</td>
<td class="description last">(Optional) Target key.</td>
</tr>
<tr>
<td class="name"><code>noNotify</code></td>
<td class="type">
<span class="param-type">boolean=</span>
</td>
<td class="description last">(Optional) No notify.</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 126</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="canRotate"><span class="type-signature"></span>canRotate</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 213</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Can rotate.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="fitExtent"><span class="type-signature"></span>fitExtent</h4>
</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>extent</code></td>
<td class="type">
<span class="param-type"><a href="ol.Extent.html">ol.Extent</a></span>
</td>
<td class="description last">Extent.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 221</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="fitUserExtent"><span class="type-signature"></span>fitUserExtent</h4>
</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>userExtent</code></td>
<td class="type">
<span class="param-type"><a href="ol.Extent.html">ol.Extent</a></span>
</td>
<td class="description last">Extent in user projection.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 237</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="freezeRendering"><span class="type-signature"></span>freezeRendering</h4>
</dt>
<dd>
<div class="description">
Freeze rendering.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 245</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="get"><span class="type-signature"></span>get</h4>
</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Key.</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 154</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Value.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getBackgroundColor"><span class="type-signature"></span>getBackgroundColor</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 253</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Background color.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Color.html">ol.Color</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCenter"><span class="type-signature"></span>getCenter</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 266</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Center.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getContainer"><span class="type-signature"></span>getContainer</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 278</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Container.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Element</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCoordinateFromPixel"><span class="type-signature"></span>getCoordinateFromPixel</h4>
</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"><a href="ol.Pixel.html">ol.Pixel</a></span>
</td>
<td class="description last">Pixel.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 287</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Coordinate.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getExtent"><span class="type-signature"></span>getExtent</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 299</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Extent.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Extent.html">ol.Extent</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getInteractions"><span class="type-signature"></span>getInteractions</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 318</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Interactions.
</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="getLayers"><span class="type-signature"></span>getLayers</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 330</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Layers.
</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>
</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.Coordinate.html">ol.Coordinate</a></span>
</td>
<td class="description last">Coordinate.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 339</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Pixel.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Pixel.html">ol.Pixel</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getProjection"><span class="type-signature"></span>getProjection</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 351</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Projection.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Projection.html">ol.Projection</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getResolution"><span class="type-signature"></span>getResolution</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 363</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Resolution.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getResolutionForExtent"><span class="type-signature"></span>getResolutionForExtent</h4>
</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>extent</code></td>
<td class="type">
<span class="param-type"><a href="ol.Extent.html">ol.Extent</a></span>
</td>
<td class="description last">Extent.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 376</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Resolution.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getRotatedExtent"><span class="type-signature"></span>getRotatedExtent</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 391</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Rotated extent.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Extent.html">ol.Extent</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getRotation"><span class="type-signature"></span>getRotation</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 416</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Rotation.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getSize"><span class="type-signature"></span>getSize</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 428</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Size.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Size.html">ol.Size</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getUserCenter"><span class="type-signature"></span>getUserCenter</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 440</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Center in user projection.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getUserExtent"><span class="type-signature"></span>getUserExtent</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 453</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Extent in user projection.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Extent.html">ol.Extent</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getUserProjection"><span class="type-signature"></span>getUserProjection</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 466</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Projection.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Projection.html">ol.Projection</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getViewport"><span class="type-signature"></span>getViewport</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 479</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Viewport.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Element</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleBrowserEvent"><span class="type-signature"></span>handleBrowserEvent</h4>
</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>browserEvent</code></td>
<td class="type">
<span class="param-type">goog.events.BrowserEvent</span>
</td>
<td class="description last">Browser event.</td>
</tr>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">string=</span>
</td>
<td class="description last">(Optional) Type.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 488</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleBrowserWindowResize"><span class="type-signature">&lt;protected> </span>handleBrowserWindowResize</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 530</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleMapBrowserEvent"><span class="type-signature"></span>handleMapBrowserEvent</h4>
</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>mapBrowserEvent</code></td>
<td class="type">
<span class="param-type"><a href="ol.MapBrowserEvent.html">ol.MapBrowserEvent</a></span>
</td>
<td class="description last">The event to handle.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 498</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleProjectionChanged"><span class="type-signature">&lt;protected> </span>handleProjectionChanged</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 514</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleUserProjectionChanged"><span class="type-signature">&lt;protected> </span>handleUserProjectionChanged</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 522</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isAnimating"><span class="type-signature"></span>isAnimating</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 540</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Is animating.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isDef"><span class="type-signature"></span>isDef</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 548</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Is defined.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="notify"><span class="type-signature"></span>notify</h4>
</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Key.</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 175</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="onAnimationFrame"><span class="type-signature"></span>onAnimationFrame</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 558</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="render"><span class="type-signature"></span>render</h4>
</dt>
<dd>
<div class="description">
Render.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 588</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="rotate"><span class="type-signature"></span>rotate</h4>
</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>rotation</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last">Rotation.</td>
</tr>
<tr>
<td class="name"><code>delta</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Delta.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 627</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="set"><span class="type-signature"></span>set</h4>
</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Key.</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">Value.</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 202</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setBackgroundColor"><span class="type-signature"></span>setBackgroundColor</h4>
</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>backgroundColor</code></td>
<td class="type">
<span class="param-type"><a href="ol.Color.html">ol.Color</a></span>
</td>
<td class="description last">Background color.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 636</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setCenter"><span class="type-signature"></span>setCenter</h4>
</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>center</code></td>
<td class="type">
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last">Center.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 648</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setInteractions"><span class="type-signature"></span>setInteractions</h4>
</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>interactions</code></td>
<td class="type">
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
</td>
<td class="description last">Interactions.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 660</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setLayers"><span class="type-signature"></span>setLayers</h4>
</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>layers</code></td>
<td class="type">
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
</td>
<td class="description last">Layers.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 672</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setOptions"><span class="type-signature"></span>setOptions</h4>
</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">Object.&lt;string, *></span>
</td>
<td class="description last">Options.</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#setOptions">ol.Object#setOptions</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>object.js, line 224</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setProjection"><span class="type-signature"></span>setProjection</h4>
</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>projection</code></td>
<td class="type">
<span class="param-type"><a href="ol.Projection.html">ol.Projection</a></span>
</td>
<td class="description last">Projection.</td>
</tr>
</tbody>
</table>
<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>
</dd>
<dt>
<h4 class="name" id="setResolution"><span class="type-signature"></span>setResolution</h4>
</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>resolution</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last">Resolution.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 696</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setRotation"><span class="type-signature"></span>setRotation</h4>
</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>rotation</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last">Rotation.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 708</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setSize"><span class="type-signature"></span>setSize</h4>
</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>size</code></td>
<td class="type">
<span class="param-type"><a href="ol.Size.html">ol.Size</a></span>
</td>
<td class="description last">Size.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 720</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setUserCenter"><span class="type-signature"></span>setUserCenter</h4>
</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>userCenter</code></td>
<td class="type">
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
</td>
<td class="description last">Center in user projection.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 732</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setUserProjection"><span class="type-signature"></span>setUserProjection</h4>
</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>userProjection</code></td>
<td class="type">
<span class="param-type"><a href="ol.Projection.html">ol.Projection</a></span>
</td>
<td class="description last">User projection.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 744</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="startAnimating"><span class="type-signature"></span>startAnimating</h4>
</dt>
<dd>
<div class="description">
Start animating.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 756</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="stopAnimating"><span class="type-signature"></span>stopAnimating</h4>
</dt>
<dd>
<div class="description">
Stop animating.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 769</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="unbind"><span class="type-signature"></span>unbind</h4>
</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Key.</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 245</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="unbindAll"><span class="type-signature"></span>unbindAll</h4>
</dt>
<dd>
<div class="description">
Removes all bindings.
</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 262</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="unfreezeRendering"><span class="type-signature"></span>unfreezeRendering</h4>
</dt>
<dd>
<div class="description">
Unfreeze rendering.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 783</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="withFrozenRendering"><span class="type-signature"></span>withFrozenRendering</h4>
</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>f</code></td>
<td class="type">
<span class="param-type">function(this: T)</span>
</td>
<td class="description last">Function.</td>
</tr>
<tr>
<td class="name"><code>obj</code></td>
<td class="type">
<span class="param-type">T=</span>
</td>
<td class="description last">(Optional) Object.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 798</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="zoom"><span class="type-signature"></span>zoom</h4>
</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>delta</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Delta from previous zoom level.</td>
</tr>
<tr>
<td class="name"><code>anchor</code></td>
<td class="type">
<span class="param-type">ol.Coordinate=</span>
</td>
<td class="description last">(Optional) Anchor coordinate.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 835</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="zoomToResolution"><span class="type-signature"></span>zoomToResolution</h4>
</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>resolution</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last">Resolution to go to.</td>
</tr>
<tr>
<td class="name"><code>anchor</code></td>
<td class="type">
<span class="param-type">ol.Coordinate=</span>
</td>
<td class="description last">(Optional) Anchor coordinate.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 845</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.Color.html">ol.Color</a></li><li><a href="ol.Constraints.html">ol.Constraints</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.MousePosition.html">ol.control.MousePosition</a></li><li><a href="ol.control.Zoom.html">ol.control.Zoom</a></li><li><a href="ol.Coordinate.html">ol.Coordinate</a></li><li><a href="ol.CoverageArea.html">ol.CoverageArea</a></li><li><a href="ol.Extent.html">ol.Extent</a></li><li><a href="ol.interaction.AltDragRotate.html">ol.interaction.AltDragRotate</a></li><li><a href="ol.interaction.DblClickZoom.html">ol.interaction.DblClickZoom</a></li><li><a href="ol.interaction.Drag.html">ol.interaction.Drag</a></li><li><a href="ol.interaction.DragPan.html">ol.interaction.DragPan</a></li><li><a href="ol.interaction.Interaction.html">ol.interaction.Interaction</a></li><li><a href="ol.interaction.Keyboard.html">ol.interaction.Keyboard</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.MouseWheelZoom.html">ol.interaction.MouseWheelZoom</a></li><li><a href="ol.interaction.ShiftDragRotateAndZoom.html">ol.interaction.ShiftDragRotateAndZoom</a></li><li><a href="ol.interaction.ShiftDragZoom.html">ol.interaction.ShiftDragZoom</a></li><li><a href="ol.layer.Layer.html">ol.layer.Layer</a></li><li><a href="ol.layer.TileLayer.html">ol.layer.TileLayer</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.MapBrowserEventHandler.html">ol.MapBrowserEventHandler</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.Pixel.html">ol.Pixel</a></li><li><a href="ol.PixelBounds.html">ol.PixelBounds</a></li><li><a href="ol.Proj4jsProjection.html">ol.Proj4jsProjection</a></li><li><a href="ol.Projection.html">ol.Projection</a></li><li><a href="ol.Rectangle.html">ol.Rectangle</a></li><li><a href="ol.renderer.dom.Layer.html">ol.renderer.dom.Layer</a></li><li><a href="ol.renderer.dom.Map.html">ol.renderer.dom.Map</a></li><li><a href="ol.renderer.dom.TileLayer.html">ol.renderer.dom.TileLayer</a></li><li><a href="ol.renderer.Layer.html">ol.renderer.Layer</a></li><li><a href="ol.renderer.Map.html">ol.renderer.Map</a></li><li><a href="ol.renderer.webgl.FragmentShader.html">ol.renderer.webgl.FragmentShader</a></li><li><a href="ol.renderer.webgl.Layer.html">ol.renderer.webgl.Layer</a></li><li><a href="ol.renderer.webgl.Map.html">ol.renderer.webgl.Map</a></li><li><a href="ol.renderer.webgl.map.shader.Fragment.html">ol.renderer.webgl.map.shader.Fragment</a></li><li><a href="ol.renderer.webgl.map.shader.Vertex.html">ol.renderer.webgl.map.shader.Vertex</a></li><li><a href="ol.renderer.webgl.Shader.html">ol.renderer.webgl.Shader</a></li><li><a href="ol.renderer.webgl.TileLayer.html">ol.renderer.webgl.TileLayer</a></li><li><a href="ol.renderer.webgl.tilelayerrenderer.shader.Fragment.html">ol.renderer.webgl.tilelayerrenderer.shader.Fragment</a></li><li><a href="ol.renderer.webgl.tilelayerrenderer.shader.Vertex.html">ol.renderer.webgl.tilelayerrenderer.shader.Vertex</a></li><li><a href="ol.renderer.webgl.VertexShader.html">ol.renderer.webgl.VertexShader</a></li><li><a href="ol.Size.html">ol.Size</a></li><li><a href="ol.source.BingMaps.html">ol.source.BingMaps</a></li><li><a href="ol.source.MapQuestOpenAerial.html">ol.source.MapQuestOpenAerial</a></li><li><a href="ol.source.MapQuestOSM.html">ol.source.MapQuestOSM</a></li><li><a href="ol.source.OpenStreetMap.html">ol.source.OpenStreetMap</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.TileJSON.html">ol.source.TileJSON</a></li><li><a href="ol.source.TileSource.html">ol.source.TileSource</a></li><li><a href="ol.source.XYZ.html">ol.source.XYZ</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.TileCoverageArea.html">ol.TileCoverageArea</a></li><li><a href="ol.tilegrid.TileGrid.html">ol.tilegrid.TileGrid</a></li><li><a href="ol.tilegrid.XYZ.html">ol.tilegrid.XYZ</a></li><li><a href="ol.TileRange.html">ol.TileRange</a></li></ul><h3>Global</h3><ul><li><a href="global.html#{number}">{number}</a></li><li><a href="global.html#grid">grid</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a> on Fri Sep 28 2012 10:51:39 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
</body>
</html>