Files
openlayers/float-no-zero/apidoc/olx.html
2014-03-07 10:55:12 +01:00

2275 lines
46 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers 3 API Documentation - Namespace: olx</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>
olx
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>olx.jsdoc, line 1</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Namespaces</h3>
<dl>
<dt><a href="namespaces.html#olx.animation"><a href="olx.animation.html">olx.animation</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#olx.control"><a href="olx.control.html">olx.control</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#olx.format"><a href="olx.format.html">olx.format</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#olx.interaction"><a href="olx.interaction.html">olx.interaction</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#olx.layer"><a href="olx.layer.html">olx.layer</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#olx.parser"><a href="olx.parser.html">olx.parser</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#olx.render"><a href="olx.render.html">olx.render</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#olx.source"><a href="olx.source.html">olx.source</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#olx.style"><a href="olx.style.html">olx.style</a></a></dt>
<dd></dd>
<dt><a href="namespaces.html#olx.tilegrid"><a href="olx.tilegrid.html">olx.tilegrid</a></a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">TypeDefs</h3>
<dl>
<dt class="">
<h4 class="name" id="AttributionOptions">AttributionOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</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="DeviceOptions">DeviceOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</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>loadTilesWhileAnimating</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>When set to false, no tiles will be loaded while animating, which improves responsiveness on devices with slow memory. Default is <code>true</code>.</p></td>
</tr>
<tr>
<td class="name"><code>loadTilesWhileInteracting</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>When set to false, no tiles will be loaded while interacting, which improves responsiveness on devices with slow memory. Default is <code>true</code>.</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="DeviceOrientationOptions">DeviceOrientationOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</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>Start tracking. Default is <code>false</code>.</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="FeatureOverlayOptions">FeatureOverlayOptions</h4>
<div class="stability">Stability: not documented</div>
</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>features</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Feature.html">ol.Feature</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>Features.</p></td>
</tr>
<tr>
<td class="name"><code>map</code></td>
<td class="type">
<span class="param-type"><a href="ol.Map.html">ol.Map</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Map.</p></td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type"><a href="ol.style.Style.html">ol.style.Style</a></span>
|
<span class="param-type">Array.&lt;<a href="ol.style.Style.html">ol.style.Style</a>></span>
|
<span class="param-type"><a href="ol.feature_.html#StyleFunction">ol.feature.StyleFunction</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Feature style.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 101</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="GeolocationOptions">GeolocationOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</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>Start Tracking. Default is <code>false</code>.</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.proj.html#ProjectionLike">ol.proj.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 7</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="MapOptions">MapOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</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>deviceOptions</code></td>
<td class="type">
<span class="param-type"><a href="olx.html#DeviceOptions">olx.DeviceOptions</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Device options for the map.</p></td>
</tr>
<tr>
<td class="name"><code>pixelRatio</code></td>
<td class="type">
<span class="param-type"><a href="global.html#number">number</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The ratio between physical
pixels and device-independent pixels (dips) on the device. If <code>undefined</code>
then it gets set by using <code>window.devicePixelRatio</code>.</p></td>
</tr>
<tr>
<td class="name"><code>interactions</code></td>
<td class="type">
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
|
<span class="param-type">Array.&lt;<a href="ol.interaction.Interaction.html">ol.interaction.Interaction</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Interactions that are initially added to the map.</p></td>
</tr>
<tr>
<td class="name"><code>keyboardEventTarget</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">Document</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The element to listen to keyboard events on.
This determines when the <code>KeyboardPan</code> and <code>KeyboardZoom</code> interactions trigger. For example, if
this option is set to <code>document</code> the keyboard interactions will always trigger. If this option
is not specified, the element the library listens to keyboard events on is the map target (i.e.
the user-provided div for the map). If this is not <code>document</code> the target element needs to be
focused for key events to be emitted, requiring that the target element has a <code>tabindex</code>
attribute.</p></td>
</tr>
<tr>
<td class="name"><code>layers</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.layer.Base.html">ol.layer.Base</a>></span>
|
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Layers.</p></td>
</tr>
<tr>
<td class="name"><code>ol3Logo</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Show ol3 logo. Default is <code>true</code>.</p></td>
</tr>
<tr>
<td class="name"><code>overlays</code></td>
<td class="type">
<span class="param-type"><a href="ol.Collection.html">ol.Collection</a></span>
|
<span class="param-type">Array.&lt;<a href="ol.Overlay.html">ol.Overlay</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Overlays initially added to the map.</p></td>
</tr>
<tr>
<td class="name"><code>renderer</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#RendererHint">ol.RendererHint</a></span>
|
<span class="param-type">Array.&lt;(<a href="ol.html#RendererHint">ol.RendererHint</a>|string)></span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Renderer.</p></td>
</tr>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The container for the map.</p></td>
</tr>
<tr>
<td class="name"><code>view</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#IView">ol.IView</a></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 9</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="OverlayOptions">OverlayOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</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">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Positioning.</p></td>
</tr>
<tr>
<td class="name"><code>stopEvent</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Whether event propagation to the map
viewport should be stopped. Default is <code>true</code>. If <code>true</code> the overlay is
placed in the same container as that of the controls
(<code>ol-overlaycontainer-stopevent</code>).</p></td>
</tr>
<tr>
<td class="name"><code>insertFirst</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 overlay is inserted
first in the overlay container, or appended. Default is <code>true</code>. If the
overlay is placed in the same container as that of the controls (see
the <code>stopEvent</code> option) you will probably set <code>insertFirst</code> to <code>true</code>
so the overlay is displayed below the controls.</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="Proj4jsProjectionOptions">Proj4jsProjectionOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</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. <code>EPSG:31256</code>.</p></td>
</tr>
<tr>
<td class="name"><code>extent</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#Extent">ol.Extent</a></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 <code>false</code>.</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="ProjectionOptions">ProjectionOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</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. <code>EPSG:4326</code>.</p></td>
</tr>
<tr>
<td class="name"><code>units</code></td>
<td class="type">
<span class="param-type"><a href="ol.proj.html#Units">ol.proj.Units</a></span>
|
<span class="param-type">string</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"><a href="ol.html#Extent">ol.Extent</a></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 <code>enu</code>.</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 <code>false</code>.</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="View2DOptions">View2DOptions</h4>
<div class="stability stability-experimental">Stability: experimental</div>
</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. Default is <code>undefined</code>, and layer sources will not be fetched if
this is not set.</p></td>
</tr>
<tr>
<td class="name"><code>constrainRotation</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type"><a href="global.html#number">number</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Rotation constraint.
<code>false</code> means no constraint. <code>true</code> means no constraint, but snap to
zero near zero. A number constraints the rotation to that number of
values. For example, <code>4</code> will constrain the rotation to 0, 90, 180, and
270 degrees. The default is <code>true</code>.</p></td>
</tr>
<tr>
<td class="name"><code>enableRotation</code></td>
<td class="type">
<span class="param-type">boolean</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Enable rotation. Default is
<code>true</code>.</p></td>
</tr>
<tr>
<td class="name"><code>extent</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#Extent">ol.Extent</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The extent that constrains the center,
in other words, center cannot be set outside this extent.
Default is <code>undefined</code>.</p></td>
</tr>
<tr>
<td class="name"><code>maxResolution</code></td>
<td class="type">
<span class="param-type"><a href="global.html#number">number</a></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
<code>40075016.68557849 / 256 = 156543.03392804097</code>.</p></td>
</tr>
<tr>
<td class="name"><code>maxZoom</code></td>
<td class="type">
<span class="param-type"><a href="global.html#number">number</a></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 <code>28</code>.</p></td>
</tr>
<tr>
<td class="name"><code>projection</code></td>
<td class="type">
<span class="param-type"><a href="ol.proj.html#ProjectionLike">ol.proj.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"><a href="global.html#number">number</a></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).
An alternative to setting this is to set <code>zoom</code>. Default is <code>undefined</code>,
and layer sources will not be fetched if neither this nor <code>zoom</code> are
defined.</p></td>
</tr>
<tr>
<td class="name"><code>resolutions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="global.html#number">number</a>></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"><a href="global.html#number">number</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The initial rotation for the view
in radians (positive rotation clockwise). Default is <code>0</code>.</p></td>
</tr>
<tr>
<td class="name"><code>zoom</code></td>
<td class="type">
<span class="param-type"><a href="global.html#number">number</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Only used if <code>resolution</code> is not defined.
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"><a href="global.html#number">number</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>The zoom factor used to determine the
resolution constraint. Used together with <code>maxResolution</code> and <code>maxZoom</code>.
Default is <code>2</code>.</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>
</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.FeatureOverlay.html">ol.FeatureOverlay</a></li><li><a href="ol.Geolocation.html">ol.Geolocation</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.Object.html">ol.Object</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.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.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.DragBox.html">ol.interaction.DragBox</a></li><li><a href="ol.interaction.DragPan.html">ol.interaction.DragPan</a></li><li><a href="ol.interaction.DragRotate.html">ol.interaction.DragRotate</a></li><li><a href="ol.interaction.DragRotateAndZoom.html">ol.interaction.DragRotateAndZoom</a></li><li><a href="ol.interaction.DragZoom.html">ol.interaction.DragZoom</a></li><li><a href="ol.interaction.Draw.html">ol.interaction.Draw</a></li><li><a href="ol.interaction.KeyboardPan.html">ol.interaction.KeyboardPan</a></li><li><a href="ol.interaction.KeyboardZoom.html">ol.interaction.KeyboardZoom</a></li><li><a href="ol.interaction.Modify.html">ol.interaction.Modify</a></li><li><a href="ol.interaction.MouseWheelZoom.html">ol.interaction.MouseWheelZoom</a></li><li><a href="ol.interaction.Select.html">ol.interaction.Select</a></li><li><a href="ol.interaction.TouchPan.html">ol.interaction.TouchPan</a></li><li><a href="ol.interaction.TouchRotate.html">ol.interaction.TouchRotate</a></li><li><a href="ol.interaction.TouchZoom.html">ol.interaction.TouchZoom</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.parser.ogc.WMSCapabilities.html">ol.parser.ogc.WMSCapabilities</a></li><li><a href="ol.proj.Projection.html">ol.proj.Projection</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.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.TopoJSON.html">ol.source.TopoJSON</a></li><li><a href="ol.source.Vector.html">ol.source.Vector</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.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><li><a href="global.html#number">number</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>