wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/UrlTemplateImageryProvider....

3620 lines
110 KiB
HTML
Raw Normal View History

first commit
2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>UrlTemplateImageryProvider - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
UrlTemplateImageryProvider
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="UrlTemplateImageryProvider">
<a href="#UrlTemplateImageryProvider" class="doc-link"></a>
new Cesium.UrlTemplateImageryProvider<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L191">Scene/UrlTemplateImageryProvider.js 191</a>
</div>
</h4>
</div>
<div class="description">
Provides imagery by requesting tiles using a specified URL template.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><a href="UrlTemplateImageryProvider.html#.ConstructorOptions">UrlTemplateImageryProvider.ConstructorOptions</a></span>
</td>
<td class="description last">
Object describing initialization options</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project
const tms = new Cesium.UrlTemplateImageryProvider({
url : Cesium.buildModuleUrl('Assets/Textures/NaturalEarthII') + '/{z}/{x}/{reverseY}.jpg',
credit : '© Analytical Graphics, Inc.',
tilingScheme : new Cesium.GeographicTilingScheme(),
maximumLevel : 5
});
// Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme.
const positron = new Cesium.UrlTemplateImageryProvider({
url : 'http://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png',
credit : 'Map tiles by CartoDB, under CC BY 3.0. Data by OpenStreetMap, under ODbL.'
});
// Access a Web Map Service (WMS) server.
const wms = new Cesium.UrlTemplateImageryProvider({
url : 'https://programs.communications.gov.au/geoserver/ows?tiled=true&amp;' +
'transparent=true&amp;format=image%2Fpng&amp;exceptions=application%2Fvnd.ogc.se_xml&amp;' +
'styles=&amp;service=WMS&amp;version=1.1.1&amp;request=GetMap&amp;' +
'layers=public%3AMyBroadband_Availability&amp;srs=EPSG%3A3857&amp;' +
'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&amp;' +
'width=256&amp;height=256',
rectangle : Cesium.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
});
// Using custom tags in your template url.
const custom = new Cesium.UrlTemplateImageryProvider({
url : 'https://yoururl/{Time}/{z}/{y}/{x}.png',
customTags : {
Time: function(imageryProvider, x, y, level) {
return '20171231'
}
}
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li>
<li><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li>
<li><a href="GoogleEarthEnterpriseMapsProvider.html">GoogleEarthEnterpriseMapsProvider</a></li>
<li><a href="OpenStreetMapImageryProvider.html">OpenStreetMapImageryProvider</a></li>
<li><a href="SingleTileImageryProvider.html">SingleTileImageryProvider</a></li>
<li><a href="TileMapServiceImageryProvider.html">TileMapServiceImageryProvider</a></li>
<li><a href="WebMapServiceImageryProvider.html">WebMapServiceImageryProvider</a></li>
<li><a href="WebMapTileServiceImageryProvider.html">WebMapTileServiceImageryProvider</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="credit">
<a href="#credit" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> credit<span class="type-signature"> : <a href="Credit.html">Credit</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L609">Scene/UrlTemplateImageryProvider.js 609</a>
</div>
</h4>
</div>
<div class="description">
Gets the credit to display when this imagery provider is active. Typically this is used to credit
the source of the imagery. This function should not be called before <a href="UrlTemplateImageryProvider.html#ready"><code>UrlTemplateImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultAlpha">
<a href="#defaultAlpha" class="doc-link"></a>
defaultAlpha<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L226">Scene/UrlTemplateImageryProvider.js 226</a>
</div>
</h4>
</div>
<div class="description">
The default alpha blending value of this provider, with 0.0 representing fully transparent and
1.0 representing fully opaque.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultBrightness">
<a href="#defaultBrightness" class="doc-link"></a>
defaultBrightness<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L253">Scene/UrlTemplateImageryProvider.js 253</a>
</div>
</h4>
</div>
<div class="description">
The default brightness of this provider. 1.0 uses the unmodified imagery color. Less than 1.0
makes the imagery darker while greater than 1.0 makes it brighter.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultContrast">
<a href="#defaultContrast" class="doc-link"></a>
defaultContrast<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L262">Scene/UrlTemplateImageryProvider.js 262</a>
</div>
</h4>
</div>
<div class="description">
The default contrast of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces
the contrast while greater than 1.0 increases it.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultDayAlpha">
<a href="#defaultDayAlpha" class="doc-link"></a>
defaultDayAlpha<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L244">Scene/UrlTemplateImageryProvider.js 244</a>
</div>
</h4>
</div>
<div class="description">
The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and
1.0 representing fully opaque.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultGamma">
<a href="#defaultGamma" class="doc-link"></a>
defaultGamma<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L287">Scene/UrlTemplateImageryProvider.js 287</a>
</div>
</h4>
</div>
<div class="description">
The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultHue">
<a href="#defaultHue" class="doc-link"></a>
defaultHue<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L270">Scene/UrlTemplateImageryProvider.js 270</a>
</div>
</h4>
</div>
<div class="description">
The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultMagnificationFilter">
<a href="#defaultMagnificationFilter" class="doc-link"></a>
defaultMagnificationFilter<span class="type-signature"> : <a href="global.html#TextureMagnificationFilter">TextureMagnificationFilter</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L303">Scene/UrlTemplateImageryProvider.js 303</a>
</div>
</h4>
</div>
<div class="description">
The default texture magnification filter to apply to this provider.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultMinificationFilter">
<a href="#defaultMinificationFilter" class="doc-link"></a>
defaultMinificationFilter<span class="type-signature"> : <a href="global.html#TextureMinificationFilter">TextureMinificationFilter</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L295">Scene/UrlTemplateImageryProvider.js 295</a>
</div>
</h4>
</div>
<div class="description">
The default texture minification filter to apply to this provider.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultNightAlpha">
<a href="#defaultNightAlpha" class="doc-link"></a>
defaultNightAlpha<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L235">Scene/UrlTemplateImageryProvider.js 235</a>
</div>
</h4>
</div>
<div class="description">
The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and
1.0 representing fully opaque.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultSaturation">
<a href="#defaultSaturation" class="doc-link"></a>
defaultSaturation<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L279">Scene/UrlTemplateImageryProvider.js 279</a>
</div>
</h4>
</div>
<div class="description">
The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
saturation while greater than 1.0 increases it.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="enablePickFeatures">
<a href="#enablePickFeatures" class="doc-link"></a>
enablePickFeatures<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L314">Scene/UrlTemplateImageryProvider.js 314</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets a value indicating whether feature picking is enabled. If true, <a href="UrlTemplateImageryProvider.html#pickFeatures"><code>UrlTemplateImageryProvider#pickFeatures</code></a> will
request the <code>options.pickFeaturesUrl</code> and attempt to interpret the features included in the response. If false,
<a href="UrlTemplateImageryProvider.html#pickFeatures"><code>UrlTemplateImageryProvider#pickFeatures</code></a> will immediately return undefined (indicating no pickable
features) without communicating with the server. Set this property to false if you know your data
source does not support picking features or if you don't want this provider's features to be pickable.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="errorEvent">
<a href="#errorEvent" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> errorEvent<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L571">Scene/UrlTemplateImageryProvider.js 571</a>
</div>
</h4>
</div>
<div class="description">
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 <a href="TileProviderError.html"><code>TileProviderError</code></a>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="hasAlphaChannel">
<a href="#hasAlphaChannel" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> hasAlphaChannel<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L634">Scene/UrlTemplateImageryProvider.js 634</a>
</div>
</h4>
</div>
<div class="description">
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. This function should
not be called before <a href="ImageryProvider.html#ready"><code>ImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumLevel">
<a href="#maximumLevel" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> maximumLevel<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L464">Scene/UrlTemplateImageryProvider.js 464</a>
</div>
</h4>
</div>
<div class="description">
Gets the maximum level-of-detail that can be requested, or undefined if there is no limit.
This function should not be called before <a href="UrlTemplateImageryProvider.html#ready"><code>UrlTemplateImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="minimumLevel">
<a href="#minimumLevel" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> minimumLevel<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L485">Scene/UrlTemplateImageryProvider.js 485</a>
</div>
</h4>
</div>
<div class="description">
Gets the minimum level-of-detail that can be requested. This function should
not be called before <a href="UrlTemplateImageryProvider.html#ready"><code>UrlTemplateImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="pickFeaturesUrl">
<a href="#pickFeaturesUrl" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> pickFeaturesUrl<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L395">Scene/UrlTemplateImageryProvider.js 395</a>
</div>
</h4>
</div>
<div class="description">
Gets the URL template to use to use to pick features. If this property is not specified,
<a href="UrlTemplateImageryProvider.html#pickFeatures"><code>UrlTemplateImageryProvider#pickFeatures</code></a> will immediately return undefined, indicating no
features picked. The URL template supports all of the keywords supported by the
<a href="UrlTemplateImageryProvider.html#url"><code>UrlTemplateImageryProvider#url</code></a> property, plus the following:
<ul>
<li><code>{i}</code>: The pixel column (horizontal coordinate) of the picked position, where the Westernmost pixel is 0.</li>
<li><code>{j}</code>: The pixel row (vertical coordinate) of the picked position, where the Northernmost pixel is 0.</li>
<li><code>{reverseI}</code>: The pixel column (horizontal coordinate) of the picked position, where the Easternmost pixel is 0.</li>
<li><code>{reverseJ}</code>: The pixel row (vertical coordinate) of the picked position, where the Southernmost pixel is 0.</li>
<li><code>{longitudeDegrees}</code>: The longitude of the picked position in degrees.</li>
<li><code>{latitudeDegrees}</code>: The latitude of the picked position in degrees.</li>
<li><code>{longitudeProjected}</code>: The longitude of the picked position in the projected coordinates of the tiling scheme.</li>
<li><code>{latitudeProjected}</code>: The latitude of the picked position in the projected coordinates of the tiling scheme.</li>
<li><code>{format}</code>: The format in which to get feature information, as specified in the <a href="GetFeatureInfoFormat.html"><code>GetFeatureInfoFormat</code></a>.</li>
</ul>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="proxy">
<a href="#proxy" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> proxy<span class="type-signature"> : <a href="Proxy.html">Proxy</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L408">Scene/UrlTemplateImageryProvider.js 408</a>
</div>
</h4>
</div>
<div class="description">
Gets the proxy used by this provider.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="ready">
<a href="#ready" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> ready<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L583">Scene/UrlTemplateImageryProvider.js 583</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating whether or not the provider is ready for use.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="readyPromise">
<a href="#readyPromise" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> readyPromise<span class="type-signature"> : Promise.&lt;Boolean></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L595">Scene/UrlTemplateImageryProvider.js 595</a>
</div>
</h4>
</div>
<div class="description">
Gets a promise that resolves to true when the provider is ready for use.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="rectangle">
<a href="#rectangle" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> rectangle<span class="type-signature"> : <a href="Rectangle.html">Rectangle</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L527">Scene/UrlTemplateImageryProvider.js 527</a>
</div>
</h4>
</div>
<div class="description">
Gets the rectangle, in radians, of the imagery provided by this instance. This function should
not be called before <a href="UrlTemplateImageryProvider.html#ready"><code>UrlTemplateImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">tilingScheme.rectangle</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="tileDiscardPolicy">
<a href="#tileDiscardPolicy" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tileDiscardPolicy<span class="type-signature"> : <a href="TileDiscardPolicy.html">TileDiscardPolicy</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L550">Scene/UrlTemplateImageryProvider.js 550</a>
</div>
</h4>
</div>
<div class="description">
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. This function should
not be called before <a href="UrlTemplateImageryProvider.html#ready"><code>UrlTemplateImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="tileHeight">
<a href="#tileHeight" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tileHeight<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L443">Scene/UrlTemplateImageryProvider.js 443</a>
</div>
</h4>
</div>
<div class="description">
Gets the height of each tile, in pixels. This function should
not be called before <a href="UrlTemplateImageryProvider.html#ready"><code>UrlTemplateImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">256</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="tileWidth">
<a href="#tileWidth" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tileWidth<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L422">Scene/UrlTemplateImageryProvider.js 422</a>
</div>
</h4>
</div>
<div class="description">
Gets the width of each tile, in pixels. This function should
not be called before <a href="UrlTemplateImageryProvider.html#ready"><code>UrlTemplateImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">256</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="tilingScheme">
<a href="#tilingScheme" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tilingScheme<span class="type-signature"> : <a href="TilingScheme.html">TilingScheme</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L506">Scene/UrlTemplateImageryProvider.js 506</a>
</div>
</h4>
</div>
<div class="description">
Gets the tiling scheme used by this provider. This function should
not be called before <a href="UrlTemplateImageryProvider.html#ready"><code>UrlTemplateImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new WebMercatorTilingScheme()</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="url">
<a href="#url" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> url<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L345">Scene/UrlTemplateImageryProvider.js 345</a>
</div>
</h4>
</div>
<div class="description">
Gets the URL template to use to request tiles. It has the following keywords:
<ul>
<li> <code>{z}</code>: The level of the tile in the tiling scheme. Level zero is the root of the quadtree pyramid.</li>
<li> <code>{x}</code>: The tile X coordinate in the tiling scheme, where 0 is the Westernmost tile.</li>
<li> <code>{y}</code>: The tile Y coordinate in the tiling scheme, where 0 is the Northernmost tile.</li>
<li> <code>{s}</code>: One of the available subdomains, used to overcome browser limits on the number of simultaneous requests per host.</li>
<li> <code>{reverseX}</code>: The tile X coordinate in the tiling scheme, where 0 is the Easternmost tile.</li>
<li> <code>{reverseY}</code>: The tile Y coordinate in the tiling scheme, where 0 is the Southernmost tile.</li>
<li> <code>{reverseZ}</code>: The level of the tile in the tiling scheme, where level zero is the maximum level of the quadtree pyramid. In order to use reverseZ, maximumLevel must be defined.</li>
<li> <code>{westDegrees}</code>: The Western edge of the tile in geodetic degrees.</li>
<li> <code>{southDegrees}</code>: The Southern edge of the tile in geodetic degrees.</li>
<li> <code>{eastDegrees}</code>: The Eastern edge of the tile in geodetic degrees.</li>
<li> <code>{northDegrees}</code>: The Northern edge of the tile in geodetic degrees.</li>
<li> <code>{westProjected}</code>: The Western edge of the tile in projected coordinates of the tiling scheme.</li>
<li> <code>{southProjected}</code>: The Southern edge of the tile in projected coordinates of the tiling scheme.</li>
<li> <code>{eastProjected}</code>: The Eastern edge of the tile in projected coordinates of the tiling scheme.</li>
<li> <code>{northProjected}</code>: The Northern edge of the tile in projected coordinates of the tiling scheme.</li>
<li> <code>{width}</code>: The width of each tile in pixels.</li>
<li> <code>{height}</code>: The height of each tile in pixels.</li>
</ul>
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="urlSchemeZeroPadding">
<a href="#urlSchemeZeroPadding" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> urlSchemeZeroPadding<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L369">Scene/UrlTemplateImageryProvider.js 369</a>
</div>
</h4>
</div>
<div class="description">
Gets the URL scheme zero padding for each tile coordinate. The format is '000' where each coordinate will be padded on
the left with zeros to match the width of the passed string of zeros. e.g. Setting:
urlSchemeZeroPadding : { '{x}' : '0000'}
will cause an 'x' value of 12 to return the string '0012' for {x} in the generated URL.
It has the following keywords:
<ul>
<li> <code>{z}</code>: The zero padding for the level of the tile in the tiling scheme.</li>
<li> <code>{x}</code>: The zero padding for the tile X coordinate in the tiling scheme.</li>
<li> <code>{y}</code>: The zero padding for the the tile Y coordinate in the tiling scheme.</li>
<li> <code>{reverseX}</code>: The zero padding for the tile reverseX coordinate in the tiling scheme.</li>
<li> <code>{reverseY}</code>: The zero padding for the tile reverseY coordinate in the tiling scheme.</li>
<li> <code>{reverseZ}</code>: The zero padding for the reverseZ coordinate of the tile in the tiling scheme.</li>
</ul>
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="getTileCredits">
<a href="#getTileCredits" class="doc-link"></a>
getTileCredits<span class="signature">(x, y, level)</span> &rarr; <span class="type-signature returnType">Array.&lt;<a href="Credit.html">Credit</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L737">Scene/UrlTemplateImageryProvider.js 737</a>
</div>
</h4>
</div>
<div class="description">
Gets the credits to be displayed when a given tile is displayed.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile X coordinate.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile Y coordinate.</td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile level;</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The credits to be displayed when the tile is displayed.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: <code>getTileCredits</code> must not be called before the imagery provider is ready.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pickFeatures">
<a href="#pickFeatures" class="doc-link"></a>
pickFeatures<span class="signature">(x, y, level, longitude, latitude)</span> &rarr; <span class="type-signature returnType">Promise.&lt;Array.&lt;<a href="ImageryLayerFeatureInfo.html">ImageryLayerFeatureInfo</a>>>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L794">Scene/UrlTemplateImageryProvider.js 794</a>
</div>
</h4>
</div>
<div class="description">
Asynchronously determines what features, if any, are located at a given longitude and latitude within
a tile. This function should not be called before <a href="ImageryProvider.html#ready"><code>ImageryProvider#ready</code></a> returns true.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile X coordinate.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile Y coordinate.</td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile level.</td>
</tr>
<tr>
<td class="name"><code>longitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The longitude at which to pick features.</td>
</tr>
<tr>
<td class="name"><code>latitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The latitude at which to pick features.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A promise for the picked features that will resolve when the asynchronous
picking completes. The resolved value is an array of <a href="ImageryLayerFeatureInfo.html"><code>ImageryLayerFeatureInfo</code></a>
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.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="reinitialize">
<a href="#reinitialize" class="doc-link"></a>
reinitialize<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L654">Scene/UrlTemplateImageryProvider.js 654</a>
</div>
</h4>
</div>
<div class="description">
Reinitializes this instance. Reinitializing an instance already in use is supported, but it is not
recommended because existing tiles provided by the imagery provider will not be updated.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Promise.&lt;Object></span>
|
<span class="param-type">Object</span>
</td>
<td class="description last">
Any of the options that may be passed to the <a href="UrlTemplateImageryProvider.html"><code>UrlTemplateImageryProvider</code></a> constructor.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="requestImage">
<a href="#requestImage" class="doc-link"></a>
requestImage<span class="signature">(x, y, level, <span class="optional">request</span>)</span> &rarr; <span class="type-signature returnType">Promise.&lt;(HTMLImageElement|HTMLCanvasElement)>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L761">Scene/UrlTemplateImageryProvider.js 761</a>
</div>
</h4>
</div>
<div class="description">
Requests the image for a given tile. This function should
not be called before <a href="UrlTemplateImageryProvider.html#ready"><code>UrlTemplateImageryProvider#ready</code></a> returns true.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile X coordinate.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile Y coordinate.</td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile level.</td>
</tr>
<tr>
<td class="name"><code>request</code></td>
<td class="type">
<span class="param-type"><a href="Request.html">Request</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The request object. Intended for internal use only.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
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. The resolved image may be either an
Image or a Canvas DOM object.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".ConstructorOptions">
<a href="#.ConstructorOptions" class="doc-link"></a>
Cesium.UrlTemplateImageryProvider.ConstructorOptions
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/UrlTemplateImageryProvider.js#L52">Scene/UrlTemplateImageryProvider.js 52</a>
</div>
</h4>
</div>
<div class="description">
Initialization options for the UrlTemplateImageryProvider constructor
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Promise.&lt;Object></span>
|
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">Object with the following properties:</td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">The URL template to use to request tiles. It has the following keywords:
<ul>
<li><code>{z}</code>: The level of the tile in the tiling scheme. Level zero is the root of the quadtree pyramid.</li>
<li><code>{x}</code>: The tile X coordinate in the tiling scheme, where 0 is the Westernmost tile.</li>
<li><code>{y}</code>: The tile Y coordinate in the tiling scheme, where 0 is the Northernmost tile.</li>
<li><code>{s}</code>: One of the available subdomains, used to overcome browser limits on the number of simultaneous requests per host.</li>
<li><code>{reverseX}</code>: The tile X coordinate in the tiling scheme, where 0 is the Easternmost tile.</li>
<li><code>{reverseY}</code>: The tile Y coordinate in the tiling scheme, where 0 is the Southernmost tile.</li>
<li><code>{reverseZ}</code>: The level of the tile in the tiling scheme, where level zero is the maximum level of the quadtree pyramid. In order to use reverseZ, maximumLevel must be defined.</li>
<li><code>{westDegrees}</code>: The Western edge of the tile in geodetic degrees.</li>
<li><code>{southDegrees}</code>: The Southern edge of the tile in geodetic degrees.</li>
<li><code>{eastDegrees}</code>: The Eastern edge of the tile in geodetic degrees.</li>
<li><code>{northDegrees}</code>: The Northern edge of the tile in geodetic degrees.</li>
<li><code>{westProjected}</code>: The Western edge of the tile in projected coordinates of the tiling scheme.</li>
<li><code>{southProjected}</code>: The Southern edge of the tile in projected coordinates of the tiling scheme.</li>
<li><code>{eastProjected}</code>: The Eastern edge of the tile in projected coordinates of the tiling scheme.</li>
<li><code>{northProjected}</code>: The Northern edge of the tile in projected coordinates of the tiling scheme.</li>
<li><code>{width}</code>: The width of each tile in pixels.</li>
<li><code>{height}</code>: The height of each tile in pixels.</li>
</ul></td>
</tr>
<tr>
<td class="name"><code>pickFeaturesUrl</code></td>
<td class="type">
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The URL template to use to pick features. If this property is not specified,
<a href="UrlTemplateImageryProvider.html#pickFeatures"><code>UrlTemplateImageryProvider#pickFeatures</code></a> will immediately returned undefined, indicating no
features picked. The URL template supports all of the keywords supported by the <code>url</code>
parameter, plus the following:
<ul>
<li><code>{i}</code>: The pixel column (horizontal coordinate) of the picked position, where the Westernmost pixel is 0.</li>
<li><code>{j}</code>: The pixel row (vertical coordinate) of the picked position, where the Northernmost pixel is 0.</li>
<li><code>{reverseI}</code>: The pixel column (horizontal coordinate) of the picked position, where the Easternmost pixel is 0.</li>
<li><code>{reverseJ}</code>: The pixel row (vertical coordinate) of the picked position, where the Southernmost pixel is 0.</li>
<li><code>{longitudeDegrees}</code>: The longitude of the picked position in degrees.</li>
<li><code>{latitudeDegrees}</code>: The latitude of the picked position in degrees.</li>
<li><code>{longitudeProjected}</code>: The longitude of the picked position in the projected coordinates of the tiling scheme.</li>
<li><code>{latitudeProjected}</code>: The latitude of the picked position in the projected coordinates of the tiling scheme.</li>
<li><code>{format}</code>: The format in which to get feature information, as specified in the <a href="GetFeatureInfoFormat.html"><code>GetFeatureInfoFormat</code></a>.</li>
</ul></td>
</tr>
<tr>
<td class="name"><code>urlSchemeZeroPadding</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">Gets the URL scheme zero padding for each tile coordinate. The format is '000' where
each coordinate will be padded on the left with zeros to match the width of the passed string of zeros. e.g. Setting:
urlSchemeZeroPadding : { '{x}' : '0000'}
will cause an 'x' value of 12 to return the string '0012' for {x} in the generated URL.
It the passed object has the following keywords:
<ul>
<li> <code>{z}</code>: The zero padding for the level of the tile in the tiling scheme.</li>
<li> <code>{x}</code>: The zero padding for the tile X coordinate in the tiling scheme.</li>
<li> <code>{y}</code>: The zero padding for the the tile Y coordinate in the tiling scheme.</li>
<li> <code>{reverseX}</code>: The zero padding for the tile reverseX coordinate in the tiling scheme.</li>
<li> <code>{reverseY}</code>: The zero padding for the tile reverseY coordinate in the tiling scheme.</li>
<li> <code>{reverseZ}</code>: The zero padding for the reverseZ coordinate of the tile in the tiling scheme.</li>
</ul></td>
</tr>
<tr>
<td class="name"><code>subdomains</code></td>
<td class="type">
<span class="param-type">String</span>
|
<span class="param-type">Array.&lt;String></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'abc'
</td>
<td class="description last">The subdomains to use for the <code>{s}</code> placeholder in the URL template.
If this parameter is a single string, each character in the string is a subdomain. If it is
an array, each element in the array is a subdomain.</td>
</tr>
<tr>
<td class="name"><code>credit</code></td>
<td class="type">
<span class="param-type"><a href="Credit.html">Credit</a></span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
''
</td>
<td class="description last">A credit for the data source, which is displayed on the canvas.</td>
</tr>
<tr>
<td class="name"><code>minimumLevel</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last">The minimum level-of-detail supported by the imagery provider. Take care when specifying
this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely
to result in rendering problems.</td>
</tr>
<tr>
<td class="name"><code>maximumLevel</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.</td>
</tr>
<tr>
<td class="name"><code>rectangle</code></td>
<td class="type">
<span class="param-type"><a href="Rectangle.html">Rectangle</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
Rectangle.MAX_VALUE
</td>
<td class="description last">The rectangle, in radians, covered by the image.</td>
</tr>
<tr>
<td class="name"><code>tilingScheme</code></td>
<td class="type">
<span class="param-type"><a href="TilingScheme.html">TilingScheme</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
WebMercatorTilingScheme
</td>
<td class="description last">The tiling scheme specifying how the ellipsoidal
surface is broken into tiles. If this parameter is not provided, a <a href="WebMercatorTilingScheme.html"><code>WebMercatorTilingScheme</code></a>
is used.</td>
</tr>
<tr>
<td class="name"><code>ellipsoid</code></td>
<td class="type">
<span class="param-type"><a href="Ellipsoid.html">Ellipsoid</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The ellipsoid. If the tilingScheme is specified,
this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither
parameter is specified, the WGS84 ellipsoid is used.</td>
</tr>
<tr>
<td class="name"><code>tileWidth</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
256
</td>
<td class="description last">Pixel width of image tiles.</td>
</tr>
<tr>
<td class="name"><code>tileHeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
256
</td>
<td class="description last">Pixel height of image tiles.</td>
</tr>
<tr>
<td class="name"><code>hasAlphaChannel</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">true if the images provided by this imagery provider
include an alpha channel; otherwise, false. 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 potentially reduced.</td>
</tr>
<tr>
<td class="name"><code>getFeatureInfoFormats</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="GetFeatureInfoFormat.html">GetFeatureInfoFormat</a>></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The formats in which to get feature information at a
specific location when <a href="UrlTemplateImageryProvider.html#pickFeatures"><code>UrlTemplateImageryProvider#pickFeatures</code></a> is invoked. If this
parameter is not specified, feature picking is disabled.</td>
</tr>
<tr>
<td class="name"><code>enablePickFeatures</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If true, <a href="UrlTemplateImageryProvider.html#pickFeatures"><code>UrlTemplateImageryProvider#pickFeatures</code></a> will
request the <code>pickFeaturesUrl</code> and attempt to interpret the features included in the response. If false,
<a href="UrlTemplateImageryProvider.html#pickFeatures"><code>UrlTemplateImageryProvider#pickFeatures</code></a> will immediately return undefined (indicating no pickable
features) without communicating with the server. Set this property to false if you know your data
source does not support picking features or if you don't want this provider's features to be pickable. Note
that this can be dynamically overridden by modifying the <code>UriTemplateImageryProvider#enablePickFeatures</code>
property.</td>
</tr>
<tr>
<td class="name"><code>customTags</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">Allow to replace custom keywords in the URL template. The object must have strings as keys and functions as values.</td>
</tr>
</tbody>
</table>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>