ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
fd8df2949b7b6341db8ff5ce96c7ab48925c7539
openlayers/edit/apidoc/ol.html
ahocevar 84cad42f6d Publishing edit branch
2013-09-14 00:29:38 +02:00

2807 lines
48 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers 3 API Documentation - Namespace: ol</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">
</head>
<body>
<div class="navbar navbar-inverse navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="./">OpenLayers 3 API Documentation - Namespace: ol</a>
<ul class="nav pull-right">
<li><iframe class="github-watch-button" src="http://ghbtns.com/github-btn.html?user=openlayers&repo=ol3&type=watch&count=true"
allowtransparency="true" frameborder="0" scrolling="0" height="20" width="90"></iframe></li>
<li><a href="https://twitter.com/share" class="twitter-share-button" data-count="none" data-hashtags="openlayers">&nbsp;</a></li>
<li><div class="g-plusone-wrapper"><div class="g-plusone" data-size="medium" data-annotation="none"></div></div></li>
</ul>
</div>
</div>
</div>
<div id="main">
<section>
<header>
<h2>
ol
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>ol.jsdoc, line 1</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="ol.Attribution.html">ol.Attribution</a></dt>
<dd></dd>
<dt><a href="ol.Collection.html">ol.Collection</a></dt>
<dd></dd>
<dt><a href="ol.DeviceOrientation.html">ol.DeviceOrientation</a></dt>
<dd></dd>
<dt><a href="ol.Feature.html">ol.Feature</a></dt>
<dd></dd>
<dt><a href="ol.Geolocation.html">ol.Geolocation</a></dt>
<dd></dd>
<dt><a href="ol.Map.html">ol.Map</a></dt>
<dd></dd>
<dt><a href="ol.MapBrowserEvent.html">ol.MapBrowserEvent</a></dt>
<dd></dd>
<dt><a href="ol.Object.html">ol.Object</a></dt>
<dd></dd>
<dt><a href="ol.Overlay.html">ol.Overlay</a></dt>
<dd></dd>
<dt><a href="ol.Projection.html">ol.Projection</a></dt>
<dd></dd>
<dt><a href="ol.View2D.html">ol.View2D</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Namespaces</h3>
<dl>
<dt><a href="namespaces.html#ol.animation"><a href="ol.animation.html">ol.animation</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#ol.control"><a href="ol.control.html">ol.control</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#ol.expr"><a href="ol.expr.html">ol.expr</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#ol.geom"><a href="ol.geom.html">ol.geom</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#ol.layer"><a href="ol.layer.html">ol.layer</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#ol.parser"><a href="ol.parser.html">ol.parser</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#ol.proj"><a href="ol.proj.html">ol.proj</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#ol.source"><a href="ol.source.html">ol.source</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#ol.style"><a href="ol.style.html">ol.style</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#ol.tilegrid"><a href="ol.tilegrid.html">ol.tilegrid</a></a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="">
<h4 class="name" id="inherits"><span class="type-signature">&lt;static> </span>inherits<span class="type-signature"></span></h4>
</dt>
<dd class="">
<div class="description">
<p>ol.inherits is an alias to the goog.inherits function. It is exported
for use in non-compiled application code. See ol.exports.</p>
<p>FIXME: We use a new line to fake the linter. Without the new line the
linter complains with:</p>
<p>"Missing newline between constructor and goog.inherits"</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>ol.js, line 13</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="OverlayPositioning"><span class="type-signature">&lt;static> </span>OverlayPositioning<span class="type-signature"> :string</span></h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>BOTTOM_LEFT</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
bottom-left
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>BOTTOM_RIGHT</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
bottom-right
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TOP_LEFT</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
top-left
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TOP_RIGHT</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
top-right
</td>
<td class="description last"></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>overlay.js, line 30</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="ProjectionUnits"><span class="type-signature">&lt;static> </span>ProjectionUnits<span class="type-signature"> :string</span></h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>DEGREES</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
degrees
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>FEET</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
ft
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>METERS</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
m
</td>
<td class="description last"></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>proj.js, line 37</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="RendererHint"><span class="type-signature">&lt;static> </span>RendererHint<span class="type-signature"> :string</span></h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>CANVAS</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
canvas
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>DOM</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
dom
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>WEBGL</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
webgl
</td>
<td class="description last"></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 92</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">TypeDefs</h3>
<dl>
<dt class="">
<h4 class="name" id="AttributionOptions">AttributionOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>html</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>HTML markup for this attribution.</p></td>
</tr>
<tr>
<td class="name"><code>tileRanges</code></td>
<td class="type">
<span class="param-type">Object.&lt;string, Array.&lt;ol.TileRange>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Tile ranges (FOR INTERNAL USE ONLY).</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 1</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="Coordinate">Coordinate</h4>
</dt>
<dd class="">
<div class="description">
<p>An array representing a coordinate.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>coordinate.js, line 15</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="DeviceOrientationOptions">DeviceOrientationOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<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>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Tracking.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 3</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="GeolocationOptions">GeolocationOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<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>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Tracking.</p></td>
</tr>
<tr>
<td class="name"><code>trackingOptions</code></td>
<td class="type">
<span class="param-type">GeolocationPositionOptions</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Tracking options.</p></td>
</tr>
<tr>
<td class="name"><code>projection</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#ProjectionLike">ol.ProjectionLike</a></span>
</td>
<td class="description last"><p>Projection.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 5</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="GetFeatureInfoOptions">GetFeatureInfoOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<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 coordinate relative to the map viewport.</p></td>
</tr>
<tr>
<td class="name"><code>layers</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.layer.Layer.html">ol.layer.Layer</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Layers to restrict the
query to. All map layers will be queried if not provided.</p></td>
</tr>
<tr>
<td class="name"><code>success</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>Callback for
successful queries. The passed argument is the resulting feature
information for each layer, with array indices being the same as in the
passed <code>layers</code> array or in the layer collection as returned from
<code>ol.Map#getLayers()</code> if no <code>layers</code> were provided.</p></td>
</tr>
<tr>
<td class="name"><code>error</code></td>
<td class="type">
<span class="param-type">function</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Callback for unsuccessful queries.
Note that queries with no matching features trigger the success callback,
not the error callback.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 7</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="GetFeaturesOptions">GetFeaturesOptions</h4>
</dt>
<dd class="">
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<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 coordinate relative to the map viewport.</p></td>
</tr>
<tr>
<td class="name"><code>layers</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.layer.Layer.html">ol.layer.Layer</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Layers to restrict the
query to. All layers will be queried if not provided.</p></td>
</tr>
<tr>
<td class="name"><code>success</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>Callback
for successful queries. The passed argument is the resulting features for
each layer, with array indices being the same as in the passed <code>layers</code>
array or in the layer collection as returned from <code>ol.Map#getLayers()</code> if
no layers were provided.</p></td>
</tr>
<tr>
<td class="name"><code>error</code></td>
<td class="type">
<span class="param-type">function</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Callback for unsuccessful queries.
Note that queries with no matching features trigger the success callback,
not the error callback.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 9</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="MapOptions">MapOptions</h4>
</dt>
<dd class="">
<div class="description">
<p>Object literal with config options for the map.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<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>interactions</code></td>
<td class="type">
<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>Interactions.</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.</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">undefined</span>
</td>
<td class="description last"><p>Renderer.</p></td>
</tr>
<tr>
<td class="name"><code>renderers</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.html#RendererHint">ol.RendererHint</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Renderers.</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></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 11</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="OverlayOptions">OverlayOptions</h4>
</dt>
<dd class="">
<div class="description">
<p>Object literal with config options for the overlay.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The overlay element.</p></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>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The overlay position in map
projection.</p></td>
</tr>
<tr>
<td class="name"><code>positioning</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#OverlayPositioning">ol.OverlayPositioning</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Positioning.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 13</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="Proj4jsProjectionOptions">Proj4jsProjectionOptions</h4>
</dt>
<dd class="">
<div class="description">
<p>Object literal with config options for the Proj4js projection.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>code</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The SRS identifier code, e.g. 'EPSG:31256'.</p></td>
</tr>
<tr>
<td class="name"><code>extent</code></td>
<td class="type">
<span class="param-type">ol.Extent</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The validity extent for the SRS.</p></td>
</tr>
<tr>
<td class="name"><code>global</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Whether the projection is valid for the
whole globe. Default is false.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 15</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="ProjectionLike">ProjectionLike</h4>
</dt>
<dd class="">
<div class="description">
<p>A projection as <a href="ol.Projection.html">ol.Projection</a>, SRS identifier string or undefined.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>proj.js, line 27</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="ProjectionOptions">ProjectionOptions</h4>
</dt>
<dd class="">
<div class="description">
<p>Object literal with config options for the projection.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>code</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The SRS identifier code, e.g. 'EPSG:4326'.</p></td>
</tr>
<tr>
<td class="name"><code>units</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#ProjectionUnits">ol.ProjectionUnits</a></span>
</td>
<td class="description last"><p>Units.</p></td>
</tr>
<tr>
<td class="name"><code>extent</code></td>
<td class="type">
<span class="param-type">ol.Extent</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The validity extent for the SRS.</p></td>
</tr>
<tr>
<td class="name"><code>axisOrientation</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The axis orientation as
specified in Proj4. The default is 'enu'.</p></td>
</tr>
<tr>
<td class="name"><code>global</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Whether the projection is valid for the
whole globe. Default is false.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 17</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="Size">Size</h4>
</dt>
<dd class="">
<div class="description">
<p>An array representing a size: [width, height].</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>size.js, line 5</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="View2DOptions">View2DOptions</h4>
</dt>
<dd class="">
<div class="description">
<p>Object literal with config options for the view.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<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.html#Coordinate">ol.Coordinate</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The initial center for the view.
The coordinate system for the center is specified with the <code>projection</code>
option.</p></td>
</tr>
<tr>
<td class="name"><code>maxResolution</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The maximum resolution used to
determine the resolution constraint. It is used together with <code>maxZoom</code>
and <code>zoomFactor</code>. If unspecified it is calculated in such a way that the
projection's validity extent fits in a 256x256 px tile. If the projection
is Spherical Mercator (the default) then <code>maxResolution</code> defaults to
40075016.68557849 / 256 = 156543.03392804097.</p></td>
</tr>
<tr>
<td class="name"><code>maxZoom</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The maximum zoom level used to determine
the resolution constraint. It is used together with <code>maxResolution</code> and
<code>zoomFactor</code>. Default is 28.</p></td>
</tr>
<tr>
<td class="name"><code>projection</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#ProjectionLike">ol.ProjectionLike</a></span>
</td>
<td class="description last"><p>The projection. Default is
<code>EPSG:3857</code> (Spherical Mercator).</p></td>
</tr>
<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"><p>The initial resolution for the view.
The units are <code>projection</code> units per pixel (e.g. meters per pixel).</p></td>
</tr>
<tr>
<td class="name"><code>resolutions</code></td>
<td class="type">
<span class="param-type">Array.&lt;number></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Resolutions to determine the
resolution constraint. If set the <code>maxResolution</code>, <code>maxZoom</code> and
<code>zoomFactor</code> options are ignored.</p></td>
</tr>
<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"><p>The initial rotation for the view
in radians (positive rotation clockwise).</p></td>
</tr>
<tr>
<td class="name"><code>zoom</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Zoom level used to calculate the initial
resolution for the view. The initial resolution is determined using the
<code>ol.View2D#constrainResolution</code> method.</p></td>
</tr>
<tr>
<td class="name"><code>zoomFactor</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The zoom factor used to determine the
resolution constraint. It is together with <code>maxResolution</code> and <code>maxZoom</code>.
Default is 2.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 19</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.DeviceOrientation.html">ol.DeviceOrientation</a></li><li><a href="ol.Feature.html">ol.Feature</a></li><li><a href="ol.Geolocation.html">ol.Geolocation</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.Object.html">ol.Object</a></li><li><a href="ol.Overlay.html">ol.Overlay</a></li><li><a href="ol.Projection.html">ol.Projection</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.geom.Geometry.html">ol.geom.Geometry</a></li><li><a href="ol.geom.LineString.html">ol.geom.LineString</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.SharedVertices.html">ol.geom.SharedVertices</a></li><li><a href="ol.geom2.LineStringCollection.html">ol.geom2.LineStringCollection</a></li><li><a href="ol.geom2.PointCollection.html">ol.geom2.PointCollection</a></li><li><a href="ol.interaction.DragRotateAndZoom.html">ol.interaction.DragRotateAndZoom</a></li><li><a href="ol.interaction.Modify.html">ol.interaction.Modify</a></li><li><a href="ol.interaction.Select.html">ol.interaction.Select</a></li><li><a href="ol.layer.Group.html">ol.layer.Group</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.layer.Vector2.html">ol.layer.Vector2</a></li><li><a href="ol.parser.GPX.html">ol.parser.GPX</a></li><li><a href="ol.parser.GeoJSON.html">ol.parser.GeoJSON</a></li><li><a href="ol.parser.KML.html">ol.parser.KML</a></li><li><a href="ol.parser.TopoJSON.html">ol.parser.TopoJSON</a></li><li><a href="ol.parser.WKT.html">ol.parser.WKT</a></li><li><a href="ol.parser.ogc.GML_v2.html">ol.parser.ogc.GML_v2</a></li><li><a href="ol.parser.ogc.GML_v3.html">ol.parser.ogc.GML_v3</a></li><li><a href="ol.parser.ogc.WMSCapabilities.html">ol.parser.ogc.WMSCapabilities</a></li><li><a href="ol.parser.ogc.WMTSCapabilities.html">ol.parser.ogc.WMTSCapabilities</a></li><li><a href="ol.source.BingMaps.html">ol.source.BingMaps</a></li><li><a href="ol.source.ImageStatic.html">ol.source.ImageStatic</a></li><li><a href="ol.source.ImageWMS.html">ol.source.ImageWMS</a></li><li><a href="ol.source.MapQuestOSM.html">ol.source.MapQuestOSM</a></li><li><a href="ol.source.MapQuestOpenAerial.html">ol.source.MapQuestOpenAerial</a></li><li><a href="ol.source.OSM.html">ol.source.OSM</a></li><li><a href="ol.source.Stamen.html">ol.source.Stamen</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.TileJSON.html">ol.source.TileJSON</a></li><li><a href="ol.source.TileWMS.html">ol.source.TileWMS</a></li><li><a href="ol.source.Vector.html">ol.source.Vector</a></li><li><a href="ol.source.Vector2.html">ol.source.Vector2</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.structs.Buffer.html">ol.structs.Buffer</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.Rule.html">ol.style.Rule</a></li><li><a href="ol.style.Shape.html">ol.style.Shape</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></ul><h3>Namespaces</h3><ul><li><a href="ol.html">ol</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.expr.html">ol.expr</a></li><li><a href="ol.geom.html">ol.geom</a></li><li><a href="ol.layer.html">ol.layer</a></li><li><a href="ol.parser.html">ol.parser</a></li><li><a href="ol.proj.html">ol.proj</a></li><li><a href="ol.source.html">ol.source</a></li><li><a href="ol.style.html">ol.style</a></li><li><a href="ol.tilegrid.html">ol.tilegrid</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-ol3.html">OpenLayers 3 Architecture</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Meters per unit lookup table.">Meters per unit lookup table.</a></li><li><a href="global.html#grid">grid</a></li><li>{boolean}</li><li>{number}</li><li>{string}</li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a>
</footer>
<script> prettyPrint(); </script>
<script src="../resources/social-links.js" type="text/javascript"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink