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

1410 lines
20 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers Class: ol.source.Stamen</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/apidoc.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: ol.source.Stamen</h1>
<section>
<header>
<h2>
ol.source.Stamen
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Stamen"><span class="type-signature"></span>new Stamen</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stamenOptions</code></td>
<td class="type">
<span class="param-type">ol.source.StamenOptions</span>
</td>
<td class="description last">Stamen options.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>stamen.js, line 73</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="ol.source.XYZ.html">ol.source.XYZ</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="protected">
<h4 class="name" id="isReady"><span class="type-signature"></span>isReady<span class="type-signature"></span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#isReady">ol.source.XYZ#isReady</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>source.js, line 96</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="tileGrid"><span class="type-signature">&lt;protected> </span>tileGrid<span class="type-signature"> :<a href="ol.tilegrid.TileGrid.html">ol.tilegrid.TileGrid</a></span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#tileGrid">ol.source.XYZ#tileGrid</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilesource.js, line 44</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="tileUrlFunction"><span class="type-signature">&lt;protected> </span>tileUrlFunction<span class="type-signature"> :ol.TileUrlFunctionType</span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#tileUrlFunction">ol.source.XYZ#tileUrlFunction</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilesource.js, line 51</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="dispatchLoadEvent"><span class="type-signature">&lt;protected> </span>dispatchLoadEvent</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#dispatchLoadEvent">ol.source.XYZ#dispatchLoadEvent</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>source.js, line 58</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getAttributions"><span class="type-signature"></span>getAttributions</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#getAttributions">ol.source.XYZ#getAttributions</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>source.js, line 66</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Attributions.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;ol.Attribution></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getExtent"><span class="type-signature"></span>getExtent</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#getExtent">ol.source.XYZ#getExtent</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>source.js, line 74</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Extent.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Extent.html">ol.Extent</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getProjection"><span class="type-signature"></span>getProjection</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#getProjection">ol.source.XYZ#getProjection</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>source.js, line 82</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Projection.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Projection.html">ol.Projection</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getResolutions"><span class="type-signature"></span>getResolutions</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#getResolutions">ol.source.XYZ#getResolutions</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilesource.js, line 77</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTile"><span class="type-signature"></span>getTile</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tileCoord</code></td>
<td class="type">
<span class="param-type"><a href="ol.TileCoord.html">ol.TileCoord</a></span>
</td>
<td class="description last">Tile coordinate.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#getTile">ol.source.XYZ#getTile</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilesource.js, line 86</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Tile.html">ol.Tile</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTileCoordUrl"><span class="type-signature"></span>getTileCoordUrl</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>tileCoord</code></td>
<td class="type">
<span class="param-type"><a href="ol.TileCoord.html">ol.TileCoord</a></span>
</td>
<td class="description last">Tile coordinate.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#getTileCoordUrl">ol.source.XYZ#getTileCoordUrl</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilesource.js, line 108</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile URL.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTileGrid"><span class="type-signature"></span>getTileGrid</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#getTileGrid">ol.source.XYZ#getTileGrid</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilesource.js, line 116</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile grid.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.tilegrid.TileGrid.html">ol.tilegrid.TileGrid</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setAttributions"><span class="type-signature"></span>setAttributions</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>attributions</code></td>
<td class="type">
<span class="param-type">Array.&lt;ol.Attribution></span>
</td>
<td class="description last">Attributions.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#setAttributions">ol.source.XYZ#setAttributions</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>source.js, line 102</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setExtent"><span class="type-signature"></span>setExtent</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>extent</code></td>
<td class="type">
<span class="param-type"><a href="ol.Extent.html">ol.Extent</a></span>
</td>
<td class="description last">Extent.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#setExtent">ol.source.XYZ#setExtent</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>source.js, line 110</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setProjection"><span class="type-signature"></span>setProjection</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>projection</code></td>
<td class="type">
<span class="param-type"><a href="ol.Projection.html">ol.Projection</a></span>
</td>
<td class="description last">Projetion.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.source.XYZ.html#setProjection">ol.source.XYZ#setProjection</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>source.js, line 118</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="ol.Attribution.html">ol.Attribution</a></li><li><a href="ol.Collection.html">ol.Collection</a></li><li><a href="ol.CollectionEvent.html">ol.CollectionEvent</a></li><li><a href="ol.Color.html">ol.Color</a></li><li><a href="ol.Constraints.html">ol.Constraints</a></li><li><a href="ol.control.Attribution.html">ol.control.Attribution</a></li><li><a href="ol.control.Control.html">ol.control.Control</a></li><li><a href="ol.control.MousePosition.html">ol.control.MousePosition</a></li><li><a href="ol.control.Zoom.html">ol.control.Zoom</a></li><li><a href="ol.Coordinate.html">ol.Coordinate</a></li><li><a href="ol.CoverageArea.html">ol.CoverageArea</a></li><li><a href="ol.Extent.html">ol.Extent</a></li><li><a href="ol.interaction.AltDragRotate.html">ol.interaction.AltDragRotate</a></li><li><a href="ol.interaction.DblClickZoom.html">ol.interaction.DblClickZoom</a></li><li><a href="ol.interaction.Drag.html">ol.interaction.Drag</a></li><li><a href="ol.interaction.DragPan.html">ol.interaction.DragPan</a></li><li><a href="ol.interaction.Interaction.html">ol.interaction.Interaction</a></li><li><a href="ol.interaction.Keyboard.html">ol.interaction.Keyboard</a></li><li><a href="ol.interaction.KeyboardPan.html">ol.interaction.KeyboardPan</a></li><li><a href="ol.interaction.KeyboardZoom.html">ol.interaction.KeyboardZoom</a></li><li><a href="ol.interaction.MouseWheelZoom.html">ol.interaction.MouseWheelZoom</a></li><li><a href="ol.interaction.ShiftDragRotateAndZoom.html">ol.interaction.ShiftDragRotateAndZoom</a></li><li><a href="ol.interaction.ShiftDragZoom.html">ol.interaction.ShiftDragZoom</a></li><li><a href="ol.layer.Layer.html">ol.layer.Layer</a></li><li><a href="ol.layer.TileLayer.html">ol.layer.TileLayer</a></li><li><a href="ol.Map.html">ol.Map</a></li><li><a href="ol.MapBrowserEvent.html">ol.MapBrowserEvent</a></li><li><a href="ol.MapBrowserEventHandler.html">ol.MapBrowserEventHandler</a></li><li><a href="ol.MapEvent.html">ol.MapEvent</a></li><li><a href="ol.Object.html">ol.Object</a></li><li><a href="ol.Pixel.html">ol.Pixel</a></li><li><a href="ol.PixelBounds.html">ol.PixelBounds</a></li><li><a href="ol.Proj4jsProjection.html">ol.Proj4jsProjection</a></li><li><a href="ol.Projection.html">ol.Projection</a></li><li><a href="ol.Rectangle.html">ol.Rectangle</a></li><li><a href="ol.renderer.dom.Layer.html">ol.renderer.dom.Layer</a></li><li><a href="ol.renderer.dom.Map.html">ol.renderer.dom.Map</a></li><li><a href="ol.renderer.dom.TileLayer.html">ol.renderer.dom.TileLayer</a></li><li><a href="ol.renderer.Layer.html">ol.renderer.Layer</a></li><li><a href="ol.renderer.Map.html">ol.renderer.Map</a></li><li><a href="ol.renderer.webgl.FragmentShader.html">ol.renderer.webgl.FragmentShader</a></li><li><a href="ol.renderer.webgl.Layer.html">ol.renderer.webgl.Layer</a></li><li><a href="ol.renderer.webgl.Map.html">ol.renderer.webgl.Map</a></li><li><a href="ol.renderer.webgl.map.shader.Fragment.html">ol.renderer.webgl.map.shader.Fragment</a></li><li><a href="ol.renderer.webgl.map.shader.Vertex.html">ol.renderer.webgl.map.shader.Vertex</a></li><li><a href="ol.renderer.webgl.Shader.html">ol.renderer.webgl.Shader</a></li><li><a href="ol.renderer.webgl.TileLayer.html">ol.renderer.webgl.TileLayer</a></li><li><a href="ol.renderer.webgl.tilelayerrenderer.shader.Fragment.html">ol.renderer.webgl.tilelayerrenderer.shader.Fragment</a></li><li><a href="ol.renderer.webgl.tilelayerrenderer.shader.Vertex.html">ol.renderer.webgl.tilelayerrenderer.shader.Vertex</a></li><li><a href="ol.renderer.webgl.VertexShader.html">ol.renderer.webgl.VertexShader</a></li><li><a href="ol.Size.html">ol.Size</a></li><li><a href="ol.source.BingMaps.html">ol.source.BingMaps</a></li><li><a href="ol.source.MapQuestOpenAerial.html">ol.source.MapQuestOpenAerial</a></li><li><a href="ol.source.MapQuestOSM.html">ol.source.MapQuestOSM</a></li><li><a href="ol.source.OpenStreetMap.html">ol.source.OpenStreetMap</a></li><li><a href="ol.source.Source.html">ol.source.Source</a></li><li><a href="ol.source.Stamen.html">ol.source.Stamen</a></li><li><a href="ol.source.TileJSON.html">ol.source.TileJSON</a></li><li><a href="ol.source.TileSource.html">ol.source.TileSource</a></li><li><a href="ol.source.XYZ.html">ol.source.XYZ</a></li><li><a href="ol.Tile.html">ol.Tile</a></li><li><a href="ol.TileCoord.html">ol.TileCoord</a></li><li><a href="ol.TileCoverageArea.html">ol.TileCoverageArea</a></li><li><a href="ol.tilegrid.TileGrid.html">ol.tilegrid.TileGrid</a></li><li><a href="ol.tilegrid.XYZ.html">ol.tilegrid.XYZ</a></li><li><a href="ol.TileRange.html">ol.TileRange</a></li></ul><h3>Global</h3><ul><li><a href="global.html#{number}">{number}</a></li><li><a href="global.html#grid">grid</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a> on Fri Sep 28 2012 10:51:40 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
</body>
</html>