Files
openlayers/edit/apidoc/ol.source.html
2013-09-14 00:29:38 +02:00

3590 lines
61 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers 3 API Documentation - Namespace: ol.source</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.source</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>
<span class="ancestors"><a href="ol.html">ol</a>.</span>
ol.source
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>source.jsdoc, line 1</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="ol.source.BingMaps.html">ol.source.BingMaps</a></dt>
<dd></dd>
<dt><a href="ol.source.ImageStatic.html">ol.source.ImageStatic</a></dt>
<dd></dd>
<dt><a href="ol.source.ImageWMS.html">ol.source.ImageWMS</a></dt>
<dd></dd>
<dt><a href="ol.source.MapQuestOpenAerial.html">ol.source.MapQuestOpenAerial</a></dt>
<dd></dd>
<dt><a href="ol.source.MapQuestOSM.html">ol.source.MapQuestOSM</a></dt>
<dd></dd>
<dt><a href="ol.source.OSM.html">ol.source.OSM</a></dt>
<dd></dd>
<dt><a href="ol.source.Stamen.html">ol.source.Stamen</a></dt>
<dd></dd>
<dt><a href="ol.source.Tile.html">ol.source.Tile</a></dt>
<dd></dd>
<dt><a href="ol.source.TileDebug.html">ol.source.TileDebug</a></dt>
<dd></dd>
<dt><a href="ol.source.TileJSON.html">ol.source.TileJSON</a></dt>
<dd></dd>
<dt><a href="ol.source.TileWMS.html">ol.source.TileWMS</a></dt>
<dd></dd>
<dt><a href="ol.source.Vector.html">ol.source.Vector</a></dt>
<dd></dd>
<dt><a href="ol.source.Vector2.html">ol.source.Vector2</a></dt>
<dd></dd>
<dt><a href="ol.source.WMTS.html">ol.source.WMTS</a></dt>
<dd></dd>
<dt><a href="ol.source.XYZ.html">ol.source.XYZ</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="">
<h4 class="name" id="WMSGetFeatureInfoMethod"><span class="type-signature">&lt;static> </span>WMSGetFeatureInfoMethod<span class="type-signature"> :string</span></h4>
</dt>
<dd class="">
<div class="description">
<p>Method to use to get WMS feature info.</p>
</div>
<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>IFRAME</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
iframe
</td>
<td class="description last"><p>Load the info in an IFRAME. Only works with 'text/html and 'text/plain' as
<code>INFO_FORMAT</code>.</p></td>
</tr>
<tr>
<td class="name"><code>XHR_GET</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="default">
xhr_get
</td>
<td class="description last"><p>Use an asynchronous GET request. Requires CORS headers or a server at the
same origin as the application script.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>wmssource.js, line 13</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">TypeDefs</h3>
<dl>
<dt class="">
<h4 class="name" id="BingMapsOptions">BingMapsOptions</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>culture</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Culture.</p></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Bing Maps API key. Get yours at
<a href='http://bingmapsportal.com/'>http://bingmapsportal.com/</a>.</p></td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Style.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 95</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="ImageStaticOptions">ImageStaticOptions</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>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Attribution.html">ol.Attribution</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attributions.</p></td>
</tr>
<tr>
<td class="name"><code>crossOrigin</code></td>
<td class="type">
<span class="param-type">null</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>crossOrigin setting for image
requests.</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>Extent.</p></td>
</tr>
<tr>
<td class="name"><code>imageExtent</code></td>
<td class="type">
<span class="param-type">ol.Extent</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Extent of the image.</p></td>
</tr>
<tr>
<td class="name"><code>imageSize</code></td>
<td class="type">
<span class="param-type"><a href="ol.html#Size">ol.Size</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Size of the image.</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>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Url.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 107</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="ImageWMSOptions">ImageWMSOptions</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>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Attribution.html">ol.Attribution</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attributions.</p></td>
</tr>
<tr>
<td class="name"><code>crossOrigin</code></td>
<td class="type">
<span class="param-type">null</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>crossOrigin setting for image
requests.</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>Extent.</p></td>
</tr>
<tr>
<td class="name"><code>getFeatureInfoOptions</code></td>
<td class="type">
<span class="param-type"><a href="ol.source.html#WMSGetFeatureInfoOptions">ol.source.WMSGetFeatureInfoOptions</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Options for GetFeatureInfo.</p></td>
</tr>
<tr>
<td class="name"><code>params</code></td>
<td class="type">
<span class="param-type">Object.&lt;string, *></span>
</td>
<td class="description last"><p>WMS request parameters. At least a
<code>LAYERS</code> param is required. <code>STYLES</code> is '' by default. <code>VERSION</code> is
'1.3.0' by default. <code>WIDTH</code>, <code>HEIGHT</code>, <code>BBOX</code> and <code>CRS</code> (<code>SRS</code> for WMS
version &lt; 1.3.0) will be set dynamically.</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>
<tr>
<td class="name"><code>ratio</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Ratio. 1 means image requests are the size
of the map viewport, 2 means twice the size of the map viewport, and so
on.</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. If specified,
requests will be made for these resolutions only.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>WMS service url.</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="OSMOptions">OSMOptions</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>attribution</code></td>
<td class="type">
<span class="param-type"><a href="ol.Attribution.html">ol.Attribution</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attribution.</p></td>
</tr>
<tr>
<td class="name"><code>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Attribution.html">ol.Attribution</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attributions.</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>Max zoom.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>URL.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 99</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="SourceOptions">SourceOptions</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>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Attribution.html">ol.Attribution</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attributions.</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>Extent.</p></td>
</tr>
<tr>
<td class="name"><code>logo</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Logo.</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 103</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="StamenOptions">StamenOptions</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>layer</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Layer.</p></td>
</tr>
<tr>
<td class="name"><code>minZoom</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Minimum zoom.</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>Maximum zoom.</p></td>
</tr>
<tr>
<td class="name"><code>opaque</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 layer is opaque.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Url.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 105</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="TileDebugOptions">TileDebugOptions</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>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>Extent.</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>
<tr>
<td class="name"><code>tileGrid</code></td>
<td class="type">
<span class="param-type"><a href="ol.tilegrid.TileGrid.html">ol.tilegrid.TileGrid</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Tile grid.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 97</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="TileJSONOptions">TileJSONOptions</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>crossOrigin</code></td>
<td class="type">
<span class="param-type">null</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>crossOriin setting for image
requests.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Url.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 109</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="TileWMSOptions">TileWMSOptions</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>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Attribution.html">ol.Attribution</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attributions.</p></td>
</tr>
<tr>
<td class="name"><code>params</code></td>
<td class="type">
<span class="param-type">Object.&lt;string, *></span>
</td>
<td class="description last"><p>WMS request parameters. At least a
<code>LAYERS</code> param is required. <code>STYLES</code> is '' by default. <code>VERSION</code> is
'1.3.0' by default. <code>WIDTH</code>, <code>HEIGHT</code>, <code>BBOX</code> and <code>CRS</code> (<code>SRS</code> for WMS
version &lt; 1.3.0) will be set dynamically.</p></td>
</tr>
<tr>
<td class="name"><code>crossOrigin</code></td>
<td class="type">
<span class="param-type">null</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>crossOrigin setting for image
requests.</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>Extent.</p></td>
</tr>
<tr>
<td class="name"><code>getFeatureInfoOptions</code></td>
<td class="type">
<span class="param-type"><a href="ol.source.html#WMSGetFeatureInfoOptions">ol.source.WMSGetFeatureInfoOptions</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Options for GetFeatureInfo.</p></td>
</tr>
<tr>
<td class="name"><code>tileGrid</code></td>
<td class="type">
<span class="param-type"><a href="ol.tilegrid.TileGrid.html">ol.tilegrid.TileGrid</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Tile grid.</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>Maximum zoom.</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>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>WMS service url.</p></td>
</tr>
<tr>
<td class="name"><code>urls</code></td>
<td class="type">
<span class="param-type">Array.&lt;string></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>WMS service urls. Use this instead
of <code>url</code> when the WMS supports multiple urls for GetMap requests.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 111</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="Vector2Options">Vector2Options</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>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Attribution.html">ol.Attribution</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attributions.</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>Extent.</p></td>
</tr>
<tr>
<td class="name"><code>lineStringCollections</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.geom2.LineStringCollection.html">ol.geom2.LineStringCollection</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Line string collections.</p></td>
</tr>
<tr>
<td class="name"><code>pointCollections</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.geom2.PointCollection.html">ol.geom2.PointCollection</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Point collections.</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 115</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="VectorOptions">VectorOptions</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>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Attribution.html">ol.Attribution</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attributions.</p></td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">Object</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Data to parse.</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>Extent.</p></td>
</tr>
<tr>
<td class="name"><code>logo</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Logo.</p></td>
</tr>
<tr>
<td class="name"><code>parser</code></td>
<td class="type">
<span class="param-type">ol.parser.Parser</span>
</td>
<td class="description last"><p>Parser instance to parse data
provided as <code>data</code> or fetched from <code>url</code>.</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>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Projection. Usually the
projection is provided by the parser, so this only needs to be set if
the parser does not know the SRS (e.g. in some GML flavors), or if the
projection determined by the parser needs to be overridden.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Server url providing the vector data.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 113</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="WMSGetFeatureInfoOptions">WMSGetFeatureInfoOptions</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>method</code></td>
<td class="type">
<span class="param-type"><a href="ol.source.html#WMSGetFeatureInfoMethod">ol.source.WMSGetFeatureInfoMethod</a></span>
</td>
<td class="description last"><p>Method for requesting
GetFeatureInfo. Default is <code>ol.source.WMSGetFeatureInfoMethod.IFRAME</code>.</p></td>
</tr>
<tr>
<td class="name"><code>params</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Params for the GetFeatureInfo request. Default is
<code>{'INFO_FORMAT': 'text/html'}</code>.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 118</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="WMTSOptions">WMTSOptions</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>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Attribution.html">ol.Attribution</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attributions.</p></td>
</tr>
<tr>
<td class="name"><code>crossOrigin</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">null</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>crossOrigin setting for image
requests.</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>Extent.</p></td>
</tr>
<tr>
<td class="name"><code>tileGrid</code></td>
<td class="type">
<span class="param-type"><a href="ol.tilegrid.WMTS.html">ol.tilegrid.WMTS</a></span>
</td>
<td class="description last"><p>Tile grid.</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>
<tr>
<td class="name"><code>requestEncoding</code></td>
<td class="type">
<span class="param-type"><a href="ol.source.WMTSRequestEncoding.html">ol.source.WMTSRequestEncoding</a></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Request
encoding.</p></td>
</tr>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Layer.</p></td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Style.</p></td>
</tr>
<tr>
<td class="name"><code>version</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>WMTS version. Default to '1.0.0'.</p></td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Format.</p></td>
</tr>
<tr>
<td class="name"><code>matrixSet</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Matrix set.</p></td>
</tr>
<tr>
<td class="name"><code>dimensions</code></td>
<td class="type">
<span class="param-type">Object</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Dimensions.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Url.</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>Maximum zoom.</p></td>
</tr>
<tr>
<td class="name"><code>urls</code></td>
<td class="type">
<span class="param-type">Array.&lt;string></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Urls.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 121</li></ul></dd>
</dl>
</dd>
<dt class="">
<h4 class="name" id="XYZOptions">XYZOptions</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>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ol.Attribution.html">ol.Attribution</a>></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Attributions.</p></td>
</tr>
<tr>
<td class="name"><code>crossOrigin</code></td>
<td class="type">
<span class="param-type">null</span>
|
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Cross origin setting for image
requests.</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>Extent.</p></td>
</tr>
<tr>
<td class="name"><code>logo</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Logo.</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>
<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>Optional max zoom level. The default is
18.</p></td>
</tr>
<tr>
<td class="name"><code>minZoom</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Unsupported (TODO: remove this).</p></td>
</tr>
<tr>
<td class="name"><code>tileUrlFunction</code></td>
<td class="type">
<span class="param-type">ol.TileUrlFunctionType</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>Optional
function to get tile URL given a tile coordinate and the projection.
Required if url or urls are not provided.</p></td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>URL template. Must include '{x}', '{y}',
and '{z}' placeholders.</p></td>
</tr>
<tr>
<td class="name"><code>urls</code></td>
<td class="type">
<span class="param-type">Array.&lt;string></span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last"><p>An array of URL templates.</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>objectliterals.jsdoc, line 123</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>