Files
openlayers/wmts-hidpi/apidoc/ol.Geolocation.html
T
2014-03-27 20:46:44 +01:00

3596 lines
54 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers 3 API Documentation - Class: ol.Geolocation</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.Geolocation
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Geolocation"><span class="type-signature"></span>new Geolocation</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Helper class for providing HTML5 Geolocation capabilities.
The <a href="http://dev.w3.org/geo/api/spec-source.html">Geolocation API</a>
is used to locate a user's position.</p>
<p>Example:</p>
<pre><code>var geolocation = new ol.Geolocation();
// take the projection to use from the map's view
geolocation.bindTo('projection', map.getView());
// listen to changes in position
geolocation.on('change', function(evt) {
window.console.log(geolocation.getPosition());
});</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>options</code></td>
<td class="type">
<span class="param-type"><a href="olx.html#GeolocationOptions">olx.GeolocationOptions</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Options.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 76</li></ul></dd>
</dl>
<h5>Fires:</h5>
<ul>
<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>accuracy</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="setter">no</td>
<td class="event"><code>change:accuracy</code></td>
<td class="description last">the accuracy of the position
measurement in meters</td>
</tr>
<tr>
<td class="name"><code>accuracyGeometry</code></td>
<td class="type">
<span class="param-type"><a href="ol.geom.Geometry.html">ol.geom.Geometry</a></span>
</td>
<td class="setter">no</td>
<td class="event"><code>change:accuracygeometry</code></td>
<td class="description last">a
geometry of the position accuracy.</td>
</tr>
<tr>
<td class="name"><code>altitude</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="setter">no</td>
<td class="event"><code>change:altitude</code></td>
<td class="description last">the altitude of the position in
meters above mean sea level</td>
</tr>
<tr>
<td class="name"><code>altitudeAccuracy</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="setter">no</td>
<td class="event"><code>change:altitudeaccuracy</code></td>
<td class="description last">the accuracy of the
altitude measurement in meters</td>
</tr>
<tr>
<td class="name"><code>heading</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="setter">no</td>
<td class="event"><code>change:heading</code></td>
<td class="description last">the heading of the device in
radians from north</td>
</tr>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#Coordinate">ol.Coordinate</a></span>
</td>
<td class="setter">no</td>
<td class="event"><code>change:position</code></td>
<td class="description last">the current position of
the device reported in the current projection</td>
</tr>
<tr>
<td class="name"><code>projection</code></td>
<td class="type">
<span class="param-type"><a href="ol.proj.Projection.html">ol.proj.Projection</a></span>
</td>
<td class="setter">no</td>
<td class="event"><code>change:projection</code></td>
<td class="description last">the projection to
report the position in</td>
</tr>
<tr>
<td class="name"><code>speed</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="setter">no</td>
<td class="event"><code>change:speed</code></td>
<td class="description last">the instantaneous speed of the
device in meters per second</td>
</tr>
<tr>
<td class="name"><code>tracking</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="setter">yes</td>
<td class="event"><code>change:tracking</code></td>
<td class="description last">track the device's position.</td>
</tr>
<tr>
<td class="name"><code>trackingOptions</code></td>
<td class="type">
<span class="param-type">GeolocationPositionOptions</span>
</td>
<td class="setter">yes</td>
<td class="event"><code>change:trackingoptions</code></td>
<td class="description last">PositionOptions
as defined by the HTML5 Geolocation spec at
http://dev.w3.org/geo/api/spec-source.html</td>
</tr>
</tbody>
</table>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<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 242</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="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 299</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="getAccuracy"><span class="type-signature"></span>getAccuracy</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the accuracy of the position in meters.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 211</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Position accuracy in meters.</p>
</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="getAccuracyGeometry"><span class="type-signature"></span>getAccuracyGeometry</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get a geometry of the position accuracy.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 226</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Accuracy geometry.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.geom.Geometry.html">ol.geom.Geometry</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getAltitude"><span class="type-signature"></span>getAltitude</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the altitude associated with the position.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 241</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The altitude in meters above the mean sea level.</p>
</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="getAltitudeAccuracy"><span class="type-signature"></span>getAltitudeAccuracy</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the altitude accuracy of the position.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 256</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Altitude accuracy in meters.</p>
</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="getHeading"><span class="type-signature"></span>getHeading</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the heading as radians clockwise from North.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 271</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Heading.</p>
</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="getPosition"><span class="type-signature"></span>getPosition</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the position of the device.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 286</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>position.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.html#Coordinate">ol.Coordinate</a></span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getProjection"><span class="type-signature"></span>getProjection</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the projection associated with the position.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 301</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>projection.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.proj.Projection.html">ol.proj.Projection</a></span>
|
<span class="param-type">undefined</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 358</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="getSpeed"><span class="type-signature"></span>getSpeed</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the speed in meters per second.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 316</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Speed.</p>
</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="getTracking"><span class="type-signature"></span>getTracking</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Are we tracking the user's position?</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 331</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>tracking.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTrackingOptions"><span class="type-signature"></span>getTrackingOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Get the tracking options.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 348</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://www.w3.org/TR/geolocation-API/#position-options">http://www.w3.org/TR/geolocation-API/#position-options</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>HTML 5 Gelocation
tracking options.</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">GeolocationPositionOptions</span>
|
<span class="param-type">undefined</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 378</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 62</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 75</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="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 409</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setProjection"><span class="type-signature"></span>setProjection</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Set the projection to use for transforming the coordinates.</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>projection</code></td>
<td class="type">
<span class="param-type"><a href="ol.proj.Projection.html">ol.proj.Projection</a></span>
</td>
<td class="description last"><p>Projection.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 363</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setTracking"><span class="type-signature"></span>setTracking</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Enable/disable tracking.</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>tracking</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Enable or disable tracking.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 377</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setTrackingOptions"><span class="type-signature"></span>setTrackingOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</dt>
<dd>
<div class="description">
<p>Set the tracking options.</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>options</code></td>
<td class="type">
<span class="param-type">GeolocationPositionOptions</span>
</td>
<td class="description last"><p>HTML 5 Geolocation
tracking options.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>geolocation.js, line 393</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://www.w3.org/TR/geolocation-API/#position-options">http://www.w3.org/TR/geolocation-API/#position-options</a></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 438</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 87</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 452</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 476</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 97</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.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.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.Feature.html">ol.format.Feature</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.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.Interaction.html">ol.interaction.Interaction</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.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.Source.html">ol.source.Source</a></li><li><a href="ol.source.Stamen.html">ol.source.Stamen</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.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.VectorFile.html">ol.source.VectorFile</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></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="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><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>
</footer>
<script> prettyPrint(); </script>
</body>
</html>