ev-olcs
Version:
OpenLayers Cesium integration and plugin library
70 lines (69 loc) • 43.1 kB
HTML
<html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MVTImageryProvider | ol-cesium</title><meta name="description" content="Documentation for ol-cesium"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">ol-cesium</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">ol-cesium</a></li><li><a href="MVTImageryProvider.html">MVTImageryProvider</a></li></ul><h1>Class MVTImageryProvider</h1></div><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">ImageryProvider</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in src/olcs/MVTImageryProvider.ts:37</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="MVTImageryProvider.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="MVTImageryProvider.html#credit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>credit</span></a>
<a href="MVTImageryProvider.html#errorEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error<wbr/>Event</span></a>
<a href="MVTImageryProvider.html#maximumLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>maximum<wbr/>Level</span></a>
<a href="MVTImageryProvider.html#proxy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>proxy</span></a>
<a href="MVTImageryProvider.html#tileHeight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tile<wbr/>Height</span></a>
<a href="MVTImageryProvider.html#tileWidth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tile<wbr/>Width</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="MVTImageryProvider.html#_ready" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>_ready</span></a>
<a href="MVTImageryProvider.html#hasAlphaChannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Alpha<wbr/>Channel</span></a>
<a href="MVTImageryProvider.html#minimumLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>minimum<wbr/>Level</span></a>
<a href="MVTImageryProvider.html#ready" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ready</span></a>
<a href="MVTImageryProvider.html#rectangle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>rectangle</span></a>
<a href="MVTImageryProvider.html#tileDiscardPolicy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>tile<wbr/>Discard<wbr/>Policy</span></a>
<a href="MVTImageryProvider.html#tilingScheme" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>tiling<wbr/>Scheme</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="MVTImageryProvider.html#getTileCredits" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tile<wbr/>Credits</span></a>
<a href="MVTImageryProvider.html#pickFeatures" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pick<wbr/>Features</span></a>
<a href="MVTImageryProvider.html#rasterizeFeatures" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rasterize<wbr/>Features</span></a>
<a href="MVTImageryProvider.html#readFeaturesFromBuffer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Features<wbr/>From<wbr/>Buffer</span></a>
<a href="MVTImageryProvider.html#requestImage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Image</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_MVTImageryProvider" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new MVTImagery<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MVTImageryProvider.html" class="tsd-signature-type tsd-kind-class">MVTImageryProvider</a><a href="#constructor.new_MVTImageryProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">MVTOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="MVTImageryProvider.html" class="tsd-signature-type tsd-kind-class">MVTImageryProvider</a></h4><aside class="tsd-sources"><ul><li>Defined in src/olcs/MVTImageryProvider.ts:146</li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="credit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>credit</span><a href="#credit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">credit</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Credit</span></div><div class="tsd-comment tsd-typography"><p>Gets the credit to display when this imagery provider is active. Typically this is used to credit
the source of the imagery.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.credit</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:91</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="errorEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>error<wbr/>Event</span><a href="#errorEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">error<wbr/>Event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Event</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing
to the event, you will be notified of the error and can potentially recover from it. Event listeners
are passed an instance of Cesium.TileProviderError.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.errorEvent</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:85</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="maximumLevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>maximum<wbr/>Level</span><a href="#maximumLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">maximum<wbr/>Level</span><span class="tsd-signature-symbol"> = 20</span></div><div class="tsd-comment tsd-typography"><p>Gets the maximum level-of-detail that can be requested.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.maximumLevel</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:47</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="proxy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>proxy</span><a href="#proxy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">proxy</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Proxy</span></div><div class="tsd-comment tsd-typography"><p>Gets the proxy used by this provider.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.proxy</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:100</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tileHeight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>tile<wbr/>Height</span><a href="#tileHeight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tile<wbr/>Height</span><span class="tsd-signature-symbol"> = 256</span></div><div class="tsd-comment tsd-typography"><p>Gets the height of each tile, in pixels.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.tileHeight</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:46</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tileWidth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>tile<wbr/>Width</span><a href="#tileWidth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tile<wbr/>Width</span><span class="tsd-signature-symbol"> = 256</span></div><div class="tsd-comment tsd-typography"><p>Gets the width of each tile, in pixels.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.tileWidth</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:45</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><section class="tsd-panel tsd-member"><a id="_ready" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>_ready</span><a href="#_ready" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="_ready._ready-1"><span class="tsd-signature-keyword">get</span> _ready<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in src/olcs/MVTImageryProvider.ts:102</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hasAlphaChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Alpha<wbr/>Channel</span><a href="#hasAlphaChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="hasAlphaChannel.hasAlphaChannel-1"><span class="tsd-signature-keyword">get</span> hasAlphaChannel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets a value indicating whether or not the images provided by this imagery provider
include an alpha channel. If this property is false, an alpha channel, if present, will
be ignored. If this property is true, any images without an alpha channel will be treated
as if their alpha is 1.0 everywhere. When this property is false, memory usage
and texture upload time are reduced.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.hasAlphaChannel</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:123</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="minimumLevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>minimum<wbr/>Level</span><a href="#minimumLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="minimumLevel.minimumLevel-1"><span class="tsd-signature-keyword">get</span> minimumLevel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the minimum level-of-detail that can be requested. Generally,
a minimum level should only be used when the rectangle of the imagery is small
enough that the number of tiles at the minimum level is small. An imagery
provider with more than a few tiles at the minimum level will lead to
rendering problems.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.minimumLevel</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:49</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="ready" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ready</span><a href="#ready" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="ready.ready-1"><span class="tsd-signature-keyword">get</span> ready<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>When <code>true</code>, this model is ready to render, i.e., the external binary, image,
and shader files were downloaded and the WebGL resources were created.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in src/olcs/MVTImageryProvider.ts:62</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rectangle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rectangle</span><a href="#rectangle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="rectangle.rectangle-1"><span class="tsd-signature-keyword">get</span> rectangle<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Rectangle</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the rectangle, in radians, of the imagery provided by the instance.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Rectangle</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.rectangle</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:69</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="tileDiscardPolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>tile<wbr/>Discard<wbr/>Policy</span><a href="#tileDiscardPolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="tileDiscardPolicy.tileDiscardPolicy-1"><span class="tsd-signature-keyword">get</span> tileDiscardPolicy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TileDiscardPolicy</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the tile discard policy. If not undefined, the discard policy is responsible
for filtering out "missing" tiles via its shouldDiscardImage function. If this function
returns undefined, no tiles are filtered.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TileDiscardPolicy</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.tileDiscardPolicy</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:111</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="tilingScheme" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>tiling<wbr/>Scheme</span><a href="#tilingScheme" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="tilingScheme.tilingScheme-1"><span class="tsd-signature-keyword">get</span> tilingScheme<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TilingScheme</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the tiling scheme used by the provider.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TilingScheme</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.tilingScheme</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:76</li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="getTileCredits" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Tile<wbr/>Credits</span><a href="#getTileCredits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getTileCredits.getTileCredits-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Tile<wbr/>Credits</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span>, <span class="tsd-kind-parameter">y</span>, <span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Credit</span><span class="tsd-signature-symbol">[]</span><a href="#getTileCredits.getTileCredits-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the credits to be displayed when a given tile is displayed.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The tile X coordinate.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The tile Y coordinate.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The tile level;</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Credit</span><span class="tsd-signature-symbol">[]</span></h4><p>The credits to be displayed when the tile is displayed.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.getTileCredits</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:93</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="pickFeatures" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pick<wbr/>Features</span><a href="#pickFeatures" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pickFeatures.pickFeatures-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pick<wbr/>Features</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span>, <span class="tsd-kind-parameter">y</span>, <span class="tsd-kind-parameter">level</span>, <span class="tsd-kind-parameter">longitude</span>, <span class="tsd-kind-parameter">latitude</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ImageryLayerFeatureInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#pickFeatures.pickFeatures-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Asynchronously determines what features, if any, are located at a given longitude and latitude within
a tile.
This function is optional, so it may not exist on all ImageryProviders.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The tile X coordinate.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The tile Y coordinate.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">level</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The tile level.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">longitude</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The longitude at which to pick features.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">latitude</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The latitude at which to pick features.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ImageryLayerFeatureInfo</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A promise for the picked features that will resolve when the asynchronous
picking completes. The resolved value is an array of ImageryLayerFeatureInfo
instances. The array may be empty if no features are found at the given location.
It may also be undefined if picking is not supported.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.pickFeatures</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:142</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="rasterizeFeatures" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rasterize<wbr/>Features</span><a href="#rasterizeFeatures" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="rasterizeFeatures.rasterizeFeatures-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">rasterize<wbr/>Features</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">features</span>, <span class="tsd-kind-parameter">styleFunction</span>, <span class="tsd-kind-parameter">resolution</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLCanvasElement</span><a href="#rasterizeFeatures.rasterizeFeatures-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">features</span>: <span class="tsd-signature-type">RenderFeature</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">styleFunction</span>: <span class="tsd-signature-type">StyleFunction</span></span></li><li><span><span class="tsd-kind-parameter">resolution</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLCanvasElement</span></h4><aside class="tsd-sources"><ul><li>Defined in src/olcs/MVTImageryProvider.ts:241</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="readFeaturesFromBuffer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>read<wbr/>Features<wbr/>From<wbr/>Buffer</span><a href="#readFeaturesFromBuffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="readFeaturesFromBuffer.readFeaturesFromBuffer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">read<wbr/>Features<wbr/>From<wbr/>Buffer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RenderFeature</span><span class="tsd-signature-symbol">[]</span><a href="#readFeaturesFromBuffer.readFeaturesFromBuffer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">buffer</span>: <span class="tsd-signature-type">ArrayBuffer</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RenderFeature</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in src/olcs/MVTImageryProvider.ts:183</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="requestImage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>Image</span><a href="#requestImage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="requestImage.requestImage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">request<wbr/>Image</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span>, <span class="tsd-kind-parameter">y</span>, <span class="tsd-kind-parameter">z</span>, <span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ImageryTypes</span><span class="tsd-signature-symbol">></span><a href="#requestImage.requestImage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests the image for a given tile.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The tile X coordinate.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The tile Y coordinate.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">z</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">Request</span></span><div class="tsd-comment tsd-typography"><p>The request object. Intended for internal use only.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ImageryTypes</span><span class="tsd-signature-symbol">></span></h4><p>Returns a promise for the image that will resolve when the image is available, or
undefined if there are too many active requests to the server, and the request should be retried later.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of ImageryProvider.requestImage</p><ul><li>Defined in src/olcs/MVTImageryProvider.ts:206</li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#credit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>credit</span></a><a href="#errorEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error<wbr/>Event</span></a><a href="#maximumLevel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>maximum<wbr/>Level</span></a><a href="#proxy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>proxy</span></a><a href="#tileHeight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tile<wbr/>Height</span></a><a href="#tileWidth" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tile<wbr/>Width</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#_ready" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>_ready</span></a><a href="#hasAlphaChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>has<wbr/>Alpha<wbr/>Channel</span></a><a href="#minimumLevel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>minimum<wbr/>Level</span></a><a href="#ready" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>ready</span></a><a href="#rectangle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>rectangle</span></a><a href="#tileDiscardPolicy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>tile<wbr/>Discard<wbr/>Policy</span></a><a href="#tilingScheme" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>tiling<wbr/>Scheme</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#getTileCredits" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tile<wbr/>Credits</span></a><a href="#pickFeatures" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pick<wbr/>Features</span></a><a href="#rasterizeFeatures" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rasterize<wbr/>Features</span></a><a href="#readFeaturesFromBuffer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Features<wbr/>From<wbr/>Buffer</span></a><a href="#requestImage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request<wbr/>Image</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>ol-cesium</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>