qiusj
/
learning_cesium
0
0
Fork 0
Code Issues Issues Pull Requests Releases Wiki Wiki Activity
learning_cesium/Build168/Documentation/WebMapTileServiceImageryPro...

2732 lines
85 KiB
HTML
Raw Normal View History

init project
2024-03-19 18:06:25 +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>WebMapTileServiceImageryProvider - 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>
WebMapTileServiceImageryProvider
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="WebMapTileServiceImageryProvider">
<a href="#WebMapTileServiceImageryProvider" class="doc-link"></a>
new Cesium.WebMapTileServiceImageryProvider<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Scene/WebMapTileServiceImageryProvider.js#L110">Scene/WebMapTileServiceImageryProvider.js 110</a>
</div>
</h4>
</div>
<div class="description">
Provides tiled imagery served by <a href="http://www.opengeospatial.org/standards/wmts">WMTS 1.0.0</a> compliant servers.
This provider supports HTTP KVP-encoded and RESTful GetTile requests, but does not yet support the SOAP encoding.
</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">Object</span>
</td>
<td class="description last">
Object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<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="default">
</td>
<td class="description last">
The base URL for the WMTS GetTile operation (for KVP-encoded requests) or the tile-URL template (for RESTful requests). The tile-URL template should contain the following variables: &#123;style&#125;, &#123;TileMatrixSet&#125;, &#123;TileMatrix&#125;, &#123;TileRow&#125;, &#123;TileCol&#125;. The first two are optional if actual values are hardcoded or not required by the server. The &#123;s&#125; keyword may be used to specify subdomains.</td>
</tr>
<tr>
<td class="name"><code>format</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
<code class="language-javascript">'image/jpeg'</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The MIME type for images to retrieve from the server.</td>
</tr>
<tr>
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
The layer name for WMTS requests.</td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
The style name for WMTS requests.</td>
</tr>
<tr>
<td class="name"><code>tileMatrixSetID</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">
The identifier of the TileMatrixSet to use for WMTS requests.</td>
</tr>
<tr>
<td class="name"><code>tileMatrixLabels</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A list of identifiers in the TileMatrix to use for WMTS requests, one per TileMatrix level.</td>
</tr>
<tr>
<td class="name"><code>clock</code></td>
<td class="type">
<span class="param-type"><a href="Clock.html">Clock</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A Clock instance that is used when determining the value for the time dimension. Required when options.times is specified.</td>
</tr>
<tr>
<td class="name"><code>times</code></td>
<td class="type">
<span class="param-type"><a href="TimeIntervalCollection.html">TimeIntervalCollection</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
TimeIntervalCollection with its <code>data</code> property being an object containing time dynamic dimension and their values.</td>
</tr>
<tr>
<td class="name"><code>dimensions</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A object containing static dimensions and their values.</td>
</tr>
<tr>
<td class="name"><code>tileWidth</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">256</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The tile width in pixels.</td>
</tr>
<tr>
<td class="name"><code>tileHeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">256</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The tile height in pixels.</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="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The tiling scheme corresponding to the organization of the tiles in the TileMatrixSet.</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="default">
<code class="language-javascript">Rectangle.MAX_VALUE</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The rectangle covered by the layer.</td>
</tr>
<tr>
<td class="name"><code>minimumLevel</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The minimum level-of-detail supported by the imagery provider.</td>
</tr>
<tr>
<td class="name"><code>maximumLevel</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.</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="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The ellipsoid. If not specified, the WGS84 ellipsoid is used.</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="default">
</td>
<td class="description last">
<span class="optional">optional</span>
A credit for the data source, which is displayed on the canvas.</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="default">
<code class="language-javascript">'abc'</code>
</td>
<td class="description last">
<span class="optional">optional</span>
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>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Examples:</h5>
<pre><code class="language-javascript">// Example 1. USGS shaded relief tiles (KVP)
var shadedRelief1 = new Cesium.WebMapTileServiceImageryProvider({
url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS',
layer : 'USGSShadedReliefOnly',
style : 'default',
format : 'image/jpeg',
tileMatrixSetID : 'default028mm',
// tileMatrixLabels : ['default028mm:0', 'default028mm:1', 'default028mm:2' ...],
maximumLevel: 19,
credit : new Cesium.Credit('U. S. Geological Survey')
});
viewer.imageryLayers.addImageryProvider(shadedRelief1);</code></pre>
<pre><code class="language-javascript">// Example 2. USGS shaded relief tiles (RESTful)
var shadedRelief2 = new Cesium.WebMapTileServiceImageryProvider({
url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS/tile/1.0.0/USGSShadedReliefOnly/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.jpg',
layer : 'USGSShadedReliefOnly',
style : 'default',
format : 'image/jpeg',
tileMatrixSetID : 'default028mm',
maximumLevel: 19,
credit : new Cesium.Credit('U. S. Geological Survey')
});
viewer.imageryLayers.addImageryProvider(shadedRelief2);</code></pre>
<pre><code class="language-javascript">// Example 3. NASA time dynamic weather data (RESTful)
var times = Cesium.TimeIntervalCollection.fromIso8601({
iso8601: '2015-07-30/2017-06-16/P1D',
dataCallback: function dataCallback(interval, index) {
return {
Time: Cesium.JulianDate.toIso8601(interval.start)
};
}
});
var weather = new Cesium.WebMapTileServiceImageryProvider({
url : 'https://gibs.earthdata.nasa.gov/wmts/epsg4326/best/AMSR2_Snow_Water_Equivalent/default/{Time}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png',
layer : 'AMSR2_Snow_Water_Equivalent',
style : 'default',
tileMatrixSetID : '2km',
maximumLevel : 5,
format : 'image/png',
clock: clock,
times: times,
credit : new Cesium.Credit('NASA Global Imagery Browse Services for EOSDIS')
});
viewer.imageryLayers.addImageryProvider(weather);</code></pre>
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Web%2520Map%2520Tile%2520Service%2520with%2520Time.html">Cesium Sandcastle Web Map Tile Service with Time Demo</a></li>
</ul>
<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="UrlTemplateImageryProvider.html">UrlTemplateImageryProvider</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="clock">
<a href="#clock" class="doc-link"></a>
clock<span class="type-signature"> : <a href="Clock.html">Clock</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Scene/WebMapTileServiceImageryProvider.js#L468">Scene/WebMapTileServiceImageryProvider.js 468</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets a clock that is used to get keep the time used for time dynamic parameters.
</div>
<dl class="details">
</dl>
<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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L442">Scene/WebMapTileServiceImageryProvider.js 442</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="WebMapTileServiceImageryProvider.html#ready"><code>WebMapTileServiceImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="dimensions">
<a href="#dimensions" class="doc-link"></a>
dimensions<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Scene/WebMapTileServiceImageryProvider.js#L496">Scene/WebMapTileServiceImageryProvider.js 496</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets an object that contains static dimensions and their values.
</div>
<dl class="details">
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L395">Scene/WebMapTileServiceImageryProvider.js 395</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="format">
<a href="#format" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span>format<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Scene/WebMapTileServiceImageryProvider.js#L407">Scene/WebMapTileServiceImageryProvider.js 407</a>
</div>
</h4>
</div>
<div class="description">
Gets the mime type of images returned by this imagery provider.
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L458">Scene/WebMapTileServiceImageryProvider.js 458</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.
</div>
<dl class="details">
</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</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Scene/WebMapTileServiceImageryProvider.js#L327">Scene/WebMapTileServiceImageryProvider.js 327</a>
</div>
</h4>
</div>
<div class="description">
Gets the maximum level-of-detail that can be requested. This function should
not be called before <a href="WebMapTileServiceImageryProvider.html#ready"><code>WebMapTileServiceImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L340">Scene/WebMapTileServiceImageryProvider.js 340</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="WebMapTileServiceImageryProvider.html#ready"><code>WebMapTileServiceImageryProvider#ready</code></a> returns true.
</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"> : Proxy</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Scene/WebMapTileServiceImageryProvider.js#L288">Scene/WebMapTileServiceImageryProvider.js 288</a>
</div>
</h4>
</div>
<div class="description">
Gets the proxy used by this provider.
</div>
<dl class="details">
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L419">Scene/WebMapTileServiceImageryProvider.js 419</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L429">Scene/WebMapTileServiceImageryProvider.js 429</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L366">Scene/WebMapTileServiceImageryProvider.js 366</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="WebMapTileServiceImageryProvider.html#ready"><code>WebMapTileServiceImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L381">Scene/WebMapTileServiceImageryProvider.js 381</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="WebMapTileServiceImageryProvider.html#ready"><code>WebMapTileServiceImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L314">Scene/WebMapTileServiceImageryProvider.js 314</a>
</div>
</h4>
</div>
<div class="description">
Gets the height of each tile, in pixels. This function should
not be called before <a href="WebMapTileServiceImageryProvider.html#ready"><code>WebMapTileServiceImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L301">Scene/WebMapTileServiceImageryProvider.js 301</a>
</div>
</h4>
</div>
<div class="description">
Gets the width of each tile, in pixels. This function should
not be called before <a href="WebMapTileServiceImageryProvider.html#ready"><code>WebMapTileServiceImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L353">Scene/WebMapTileServiceImageryProvider.js 353</a>
</div>
</h4>
</div>
<div class="description">
Gets the tiling scheme used by this provider. This function should
not be called before <a href="WebMapTileServiceImageryProvider.html#ready"><code>WebMapTileServiceImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="times">
<a href="#times" class="doc-link"></a>
times<span class="type-signature"> : <a href="TimeIntervalCollection.html">TimeIntervalCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Scene/WebMapTileServiceImageryProvider.js#L483">Scene/WebMapTileServiceImageryProvider.js 483</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets a time interval collection that is used to get time dynamic parameters. The data of each
TimeInterval is an object containing the keys and values of the properties that are used during
tile requests.
</div>
<dl class="details">
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L276">Scene/WebMapTileServiceImageryProvider.js 276</a>
</div>
</h4>
</div>
<div class="description">
Gets the URL of the service hosting the imagery.
</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L521">Scene/WebMapTileServiceImageryProvider.js 521</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.68/Source/Scene/WebMapTileServiceImageryProvider.js#L578">Scene/WebMapTileServiceImageryProvider.js 578</a>
</div>
</h4>
</div>
<div class="description">
Picking features is not currently supported by this imagery provider, so this function simply returns
undefined.
</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="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;(Image|Canvas)>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.68/Source/Scene/WebMapTileServiceImageryProvider.js#L540">Scene/WebMapTileServiceImageryProvider.js 540</a>
</div>
</h4>
</div>
<div class="description">
Requests the image for a given tile. This function should
not be called before <a href="WebMapTileServiceImageryProvider.html#ready"><code>WebMapTileServiceImageryProvider#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>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: <code>requestImage</code> must not be called before the imagery provider is ready.
</div>
</li>
</ul>
<dl class="details">
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</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="ArcType.html">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">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="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</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="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="BlendOption.html">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="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="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="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">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="CartographicGeocoderService.html">CartographicGeocoderService</a></li><li data-name="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="Cesium3DTile"><a href="Cesium3DTile.html">Cesium3DTile</a></li><li data-name="Cesium3DTileColorBlendMode"><a href="Cesium3DTileColorBlendMode.html">Cesium3DTileColorBlendMode</a></li><li data-name="Cesium3DTileContent"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></li><li data-
</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>