ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
c2bb8a27f08ade13d1a0b208dd54a867398d852a
openlayers/master/apidoc/ol.TileCache.html
Éric Lemoine 10ee3b644c Updated
2013-03-05 11:09:55 +01:00

1604 lines
25 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>OpenLayers: Class: ol.TileCache</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">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: ol.TileCache</h1>
<section>
<header>
<h2>
ol.TileCache
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="TileCache"><span class="type-signature"></span>new TileCache</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>highWaterMark</code></td>
<td class="type">
<span class="param-type">number=</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">(Optional) High water mark.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilecache.js, line 20</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>ol.structs.LRUCache</li>
</ul>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="assertValid"><span class="type-signature"></span>assertValid</h4>
</dt>
<dd>
<div class="description">
FIXME empty description for jsdoc
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.structs.LRUCache.html#assertValid">ol.structs.LRUCache#assertValid</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 46</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="canExpireCache"><span class="type-signature"></span>canExpireCache</h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilecache.js, line 38</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Can expire cache.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="clear"><span class="type-signature"></span>clear</h4>
</dt>
<dd>
<div class="description">
FIXME empty description for jsdoc
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.structs.LRUCache.html#clear">ol.structs.LRUCache#clear</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 81</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="containsKey"><span class="type-signature"></span>containsKey</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Key.</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.structs.LRUCache.html#containsKey">ol.structs.LRUCache#containsKey</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 93</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Contains key.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="expireCache"><span class="type-signature"></span>expireCache</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>usedTiles</code></td>
<td class="type">
<span class="param-type">Object.&lt;string, ol.TileRange></span>
</td>
<td class="description last">Used tiles.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>tilecache.js, line 46</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="forEach"><span class="type-signature"></span>forEach</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</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</span>
</td>
<td class="attributes">
</td>
<td class="description last">Function.</td>
</tr>
<tr>
<td class="name"><code>obj</code></td>
<td class="type">
<span class="param-type">Object=</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">(Optional) Object.</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.structs.LRUCache.html#forEach">ol.structs.LRUCache#forEach</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 102</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="get"><span class="type-signature"></span>get</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Key.</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.structs.LRUCache.html#get">ol.structs.LRUCache#get</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 115</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Value.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getCount"><span class="type-signature"></span>getCount</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.structs.LRUCache.html#getCount">ol.structs.LRUCache#getCount</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 138</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Count.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getKeys"><span class="type-signature"></span>getKeys</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.structs.LRUCache.html#getKeys">ol.structs.LRUCache#getKeys</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 146</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Keys.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;string></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getValues"><span class="type-signature"></span>getValues</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.structs.LRUCache.html#getValues">ol.structs.LRUCache#getValues</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 161</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Values.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="peekLast"><span class="type-signature"></span>peekLast</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.structs.LRUCache.html#peekLast">ol.structs.LRUCache#peekLast</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 176</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Last value.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="peekLastKey"><span class="type-signature"></span>peekLastKey</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.structs.LRUCache.html#peekLastKey">ol.structs.LRUCache#peekLastKey</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 185</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Last key.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="pop"><span class="type-signature"></span>pop</h4>
</dt>
<dd>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="ol.structs.LRUCache.html#pop">ol.structs.LRUCache#pop</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 194</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
value Value.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="set"><span class="type-signature"></span>set</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>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Key.</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">Value.</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.structs.LRUCache.html#set">ol.structs.LRUCache#set</a>
</li></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>lrucache.js, line 216</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="44f1750883.html">Implements a Least-Recently-Used cache where the keys do not conflict with
Object's properties (e.g. 'hasOwnProperty' is not allowed as a key). Expiring
items from the cache is the responsibility of the user.</a></li><li><a href="ol.AnchoredElement.html">ol.AnchoredElement</a></li><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.Coordinate.html">ol.Coordinate</a></li><li><a href="ol.Ellipsoid.html">ol.Ellipsoid</a></li><li><a href="ol.Extent.html">ol.Extent</a></li><li><a href="ol.Geolocation.html">ol.Geolocation</a></li><li><a href="ol.Image.html">ol.Image</a></li><li><a href="ol.ImageTile.html">ol.ImageTile</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.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.Projection.html">ol.Projection</a></li><li><a href="ol.Rectangle.html">ol.Rectangle</a></li><li><a href="ol.Size.html">ol.Size</a></li><li><a href="ol.Sphere.html">ol.Sphere</a></li><li><a href="ol.Tile.html">ol.Tile</a></li><li><a href="ol.TileCache.html">ol.TileCache</a></li><li><a href="ol.TileCoord.html">ol.TileCoord</a></li><li><a href="ol.TileQueue.html">ol.TileQueue</a></li><li><a href="ol.TileRange.html">ol.TileRange</a></li><li><a href="ol.View.html">ol.View</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.DragBox.html">ol.control.DragBox</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.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.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.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.Touch.html">ol.interaction.Touch</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.ImageLayer.html">ol.layer.ImageLayer</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.parser.XML.html">ol.parser.XML</a></li><li><a href="ol.parser.ogc.ExceptionReport.html">ol.parser.ogc.ExceptionReport</a></li><li><a href="ol.parser.ogc.OWSCommon_v1.html">ol.parser.ogc.OWSCommon_v1</a></li><li><a href="ol.parser.ogc.OWSCommon_v1_1_0.html">ol.parser.ogc.OWSCommon_v1_1_0</a></li><li><a href="ol.parser.ogc.Versioned.html">ol.parser.ogc.Versioned</a></li><li><a href="ol.parser.ogc.WMSCapabilities.html">ol.parser.ogc.WMSCapabilities</a></li><li><a href="ol.parser.ogc.WMSCapabilities_v1.html">ol.parser.ogc.WMSCapabilities_v1</a></li><li><a href="ol.parser.ogc.WMSCapabilities_v1_1.html">ol.parser.ogc.WMSCapabilities_v1_1</a></li><li><a href="ol.parser.ogc.WMSCapabilities_v1_1_0.html">ol.parser.ogc.WMSCapabilities_v1_1_0</a></li><li><a href="ol.parser.ogc.WMSCapabilities_v1_1_1.html">ol.parser.ogc.WMSCapabilities_v1_1_1</a></li><li><a href="ol.parser.ogc.WMSCapabilities_v1_1_1_WMSC.html">ol.parser.ogc.WMSCapabilities_v1_1_1_WMSC</a></li><li><a href="ol.parser.ogc.WMSCapabilities_v1_3_0.html">ol.parser.ogc.WMSCapabilities_v1_3_0</a></li><li><a href="ol.parser.ogc.WMTSCapabilities.html">ol.parser.ogc.WMTSCapabilities</a></li><li><a href="ol.parser.ogc.WMTSCapabilities_v1_0_0.html">ol.parser.ogc.WMTSCapabilities_v1_0_0</a></li><li><a href="ol.projection.EPSG3857.html">ol.projection.EPSG3857</a></li><li><a href="ol.projection.EPSG4326.html">ol.projection.EPSG4326</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.canvas.ImageLayer.html">ol.renderer.canvas.ImageLayer</a></li><li><a href="ol.renderer.canvas.Layer.html">ol.renderer.canvas.Layer</a></li><li><a href="ol.renderer.canvas.Map.html">ol.renderer.canvas.Map</a></li><li><a href="ol.renderer.canvas.TileLayer.html">ol.renderer.canvas.TileLayer</a></li><li><a href="ol.renderer.dom.ImageLayer.html">ol.renderer.dom.ImageLayer</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.webgl.FragmentShader.html">ol.renderer.webgl.FragmentShader</a></li><li><a href="ol.renderer.webgl.ImageLayer.html">ol.renderer.webgl.ImageLayer</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.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.VertexShader.html">ol.renderer.webgl.VertexShader</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.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.source.BingMaps.html">ol.source.BingMaps</a></li><li><a href="ol.source.DebugTileSource.html">ol.source.DebugTileSource</a></li><li><a href="ol.source.ImageSource.html">ol.source.ImageSource</a></li><li><a href="ol.source.ImageTileSource.html">ol.source.ImageTileSource</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.OpenStreetMap.html">ol.source.OpenStreetMap</a></li><li><a href="ol.source.SingleImageWMS.html">ol.source.SingleImageWMS</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.StaticImage.html">ol.source.StaticImage</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.TiledWMS.html">ol.source.TiledWMS</a></li><li><a href="ol.source.XYZ.html">ol.source.XYZ</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></ul><h3>Global</h3><ul><li><a href="global.html#Have Proj4js.">Have Proj4js.</a></li><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> on Tue Mar 05 2013 11:09:34 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink