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

2129 lines
26 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers Class: ol.renderer.Map</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.renderer.Map</h1>
<section>
<header>
<h2>
ol.renderer.Map
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Map"><span class="type-signature"></span>new Map</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>container</code></td>
<td class="type">
<span class="param-type">Element</span>
</td>
<td class="description last">Container.</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>
</td>
<td class="description last">Map.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 19</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>goog.Disposable</li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<dt class="protected">
<h4 class="name" id="canRotate"><span class="type-signature"></span>canRotate<span class="type-signature"></span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 112</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="createLayerRenderer"><span class="type-signature">&lt;protected> </span>createLayerRenderer<span class="type-signature"></span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 120</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="handleBackgroundColorChanged"><span class="type-signature"></span>handleBackgroundColorChanged<span class="type-signature"></span></h4>
</dt>
<dd class="protected">
<div class="description">
Handle background color changed.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 203</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="layerRenderers"><span class="type-signature">&lt;protected> </span>layerRenderers<span class="type-signature"> :Object.&lt;number, ol.renderer.Layer></span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 39</li></ul></dd>
</dl>
</dd>
<dt class="protected">
<h4 class="name" id="map"><span class="type-signature">&lt;protected> </span>map<span class="type-signature"> :<a href="ol.Map.html">ol.Map</a></span></h4>
</dt>
<dd class="protected">
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 33</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="addLayer"><span class="type-signature">&lt;protected> </span>addLayer</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>layer</code></td>
<td class="type">
<span class="param-type"><a href="ol.layer.Layer.html">ol.layer.Layer</a></span>
</td>
<td class="description last">Layer.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 103</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="disposeInternal"><span class="type-signature"></span>disposeInternal</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 126</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="forEachReadyVisibleLayer"><span class="type-signature"></span>forEachReadyVisibleLayer</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>f</code></td>
<td class="type">
<span class="param-type">function(this: T, ol.layer.Layer, ol.renderer.Layer, number)</span>
</td>
<td class="description last">Function.</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>map.js, line 144</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCoordinateFromPixel"><span class="type-signature"></span>getCoordinateFromPixel</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>pixel</code></td>
<td class="type">
<span class="param-type"><a href="ol.Pixel.html">ol.Pixel</a></span>
</td>
<td class="description last">Pixel.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 159</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Coordinate.
</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="getLayerRenderer"><span class="type-signature">&lt;protected> </span>getLayerRenderer</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>layer</code></td>
<td class="type">
<span class="param-type"><a href="ol.layer.Layer.html">ol.layer.Layer</a></span>
</td>
<td class="description last">Layer.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 172</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Layer renderer.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.renderer.Layer.html">ol.renderer.Layer</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getMap"><span class="type-signature"></span>getMap</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 183</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Map.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Map.html">ol.Map</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getPixelFromCoordinate"><span class="type-signature"></span>getPixelFromCoordinate</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>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 192</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Pixel.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.Pixel.html">ol.Pixel</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleCenterChanged"><span class="type-signature">&lt;protected> </span>handleCenterChanged</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 209</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleLayersAdd"><span class="type-signature">&lt;protected> </span>handleLayersAdd</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>collectionEvent</code></td>
<td class="type">
<span class="param-type"><a href="ol.CollectionEvent.html">ol.CollectionEvent</a></span>
</td>
<td class="description last">Collection event.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 218</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleLayersChanged"><span class="type-signature">&lt;protected> </span>handleLayersChanged</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 227</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleLayersRemove"><span class="type-signature">&lt;protected> </span>handleLayersRemove</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>collectionEvent</code></td>
<td class="type">
<span class="param-type"><a href="ol.CollectionEvent.html">ol.CollectionEvent</a></span>
</td>
<td class="description last">Collection event.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 254</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleResolutionChanged"><span class="type-signature">&lt;protected> </span>handleResolutionChanged</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 263</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleRotationChanged"><span class="type-signature">&lt;protected> </span>handleRotationChanged</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 271</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="handleSizeChanged"><span class="type-signature">&lt;protected> </span>handleSizeChanged</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 279</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeLayer"><span class="type-signature">&lt;protected> </span>removeLayer</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>layer</code></td>
<td class="type">
<span class="param-type"><a href="ol.layer.Layer.html">ol.layer.Layer</a></span>
</td>
<td class="description last">Layer.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 288</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="removeLayerRenderer"><span class="type-signature">&lt;protected> </span>removeLayerRenderer</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>layer</code></td>
<td class="type">
<span class="param-type"><a href="ol.layer.Layer.html">ol.layer.Layer</a></span>
</td>
<td class="description last">Layer.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 298</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Layer renderer.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="ol.renderer.Layer.html">ol.renderer.Layer</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="render"><span class="type-signature"></span>render</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 313</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Animating.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="setLayerRenderer"><span class="type-signature">&lt;protected> </span>setLayerRenderer</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>layer</code></td>
<td class="type">
<span class="param-type"><a href="ol.layer.Layer.html">ol.layer.Layer</a></span>
</td>
<td class="description last">Layer.</td>
</tr>
<tr>
<td class="name"><code>layerRenderer</code></td>
<td class="type">
<span class="param-type"><a href="ol.renderer.Layer.html">ol.renderer.Layer</a></span>
</td>
<td class="description last">Layer renderer.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>map.js, line 329</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>