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

2202 lines
28 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers Class: ol.tilegrid.TileGrid</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.tilegrid.TileGrid</h1>
<section>
<header>
<h2>
ol.tilegrid.TileGrid
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="TileGrid"><span class="type-signature"></span>new TileGrid</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>tileGridOptions</code></td>
<td class="type">
<span class="param-type">ol.tilegrid.TileGridOptions</span>
</td>
<td class="description last">Tile grid options.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 32</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="forEachTileCoordParentTileRange"><span class="type-signature"></span>forEachTileCoordParentTileRange</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>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type">function(this: T, number, ol.TileRange): boolean</span>
</td>
<td class="description last">Callback.</td>
</tr>
<tr>
<td class="name"><code>obj</code></td>
<td class="type">
<span class="param-type">T=</span>
</td>
<td class="description last">(Optional) Object.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 90</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getExtent"><span class="type-signature"></span>getExtent</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 107</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="getOrigin"><span class="type-signature"></span>getOrigin</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>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Z.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 116</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Origin.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getPixelBoundsForTileCoordAndResolution"><span class="type-signature"></span>getPixelBoundsForTileCoordAndResolution</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>
<tr>
<td class="name"><code>resolution</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Resolution.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 132</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Pixel bounds.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.PixelBounds.html">ol.PixelBounds</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getResolution"><span class="type-signature"></span>getResolution</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>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Z.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 151</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Resolution.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getResolutions"><span class="type-signature"></span>getResolutions</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 160</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Resolutions.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;number></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTileCoordCenter"><span class="type-signature"></span>getTileCoordCenter</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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 212</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile center.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTileCoordExtent"><span class="type-signature"></span>getTileCoordExtent</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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 226</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="getTileCoordForCoordAndResolution"><span class="type-signature"></span>getTileCoordForCoordAndResolution</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>coordinate</code></td>
<td class="type">
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
</td>
<td class="description last">Coordinate.</td>
</tr>
<tr>
<td class="name"><code>resolution</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Resolution.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 243</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile coordinate.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.TileCoord.html">ol.TileCoord</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTileCoordForCoordAndZ"><span class="type-signature"></span>getTileCoordForCoordAndZ</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>coordinate</code></td>
<td class="type">
<span class="param-type"><a href="ol.Coordinate.html">ol.Coordinate</a></span>
</td>
<td class="description last">Coordinate.</td>
</tr>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Z.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 287</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile coordinate.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.TileCoord.html">ol.TileCoord</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTileCoordResolution"><span class="type-signature"></span>getTileCoordResolution</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="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 298</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile resolution.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTileRangeExtent"><span class="type-signature"></span>getTileRangeExtent</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>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Z.</td>
</tr>
<tr>
<td class="name"><code>tileRange</code></td>
<td class="type">
<span class="param-type"><a href="ol.TileRange.html">ol.TileRange</a></span>
</td>
<td class="description last">Tile range.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 170</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="getTileRangeForExtentAndResolution"><span class="type-signature"></span>getTileRangeForExtentAndResolution</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>
<tr>
<td class="name"><code>resolution</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Resolution.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 187</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile range.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.TileRange.html">ol.TileRange</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTileRangeForExtentAndZ"><span class="type-signature"></span>getTileRangeForExtentAndZ</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>
<tr>
<td class="name"><code>z</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Z.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 202</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile range.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.TileRange.html">ol.TileRange</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getTileSize"><span class="type-signature"></span>getTileSize</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 307</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Tile size.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Size.html">ol.Size</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getZForResolution"><span class="type-signature"></span>getZForResolution</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>resolution</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Resolution.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilegrid.js, line 316</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Z.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</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:41 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
</body>
</html>