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

3288 lines
96 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>ArcGisMapServerImageryProvider - 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>
ArcGisMapServerImageryProvider
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="ArcGisMapServerImageryProvider">
<a href="#ArcGisMapServerImageryProvider" class="doc-link"></a>
new Cesium.ArcGisMapServerImageryProvider<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ArcGisMapServerImageryProvider.js#L91">Scene/ArcGisMapServerImageryProvider.js 91</a>
</div>
</h4>
</div>
<div class="description">
Provides tiled imagery hosted by an ArcGIS MapServer. By default, the server's pre-cached tiles are
used, if available.
</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="ArcGisMapServerImageryProvider.html#.ConstructorOptions">ArcGisMapServerImageryProvider.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">const esri = new Cesium.ArcGisMapServerImageryProvider({
url : 'https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer'
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<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>
<li><a href="UrlTemplateImageryProvider.html">UrlTemplateImageryProvider</a></li>
<li><a href="https://developers.arcgis.com/rest/">ArcGIS Server REST API</a></li>
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</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/ArcGisMapServerImageryProvider.js#L679">Scene/ArcGisMapServerImageryProvider.js 679</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="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
</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/ArcGisMapServerImageryProvider.js#L107">Scene/ArcGisMapServerImageryProvider.js 107</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/ArcGisMapServerImageryProvider.js#L134">Scene/ArcGisMapServerImageryProvider.js 134</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/ArcGisMapServerImageryProvider.js#L143">Scene/ArcGisMapServerImageryProvider.js 143</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/ArcGisMapServerImageryProvider.js#L125">Scene/ArcGisMapServerImageryProvider.js 125</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/ArcGisMapServerImageryProvider.js#L168">Scene/ArcGisMapServerImageryProvider.js 168</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/ArcGisMapServerImageryProvider.js#L151">Scene/ArcGisMapServerImageryProvider.js 151</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/ArcGisMapServerImageryProvider.js#L184">Scene/ArcGisMapServerImageryProvider.js 184</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/ArcGisMapServerImageryProvider.js#L176">Scene/ArcGisMapServerImageryProvider.js 176</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/ArcGisMapServerImageryProvider.js#L116">Scene/ArcGisMapServerImageryProvider.js 116</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/ArcGisMapServerImageryProvider.js#L160">Scene/ArcGisMapServerImageryProvider.js 160</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/ArcGisMapServerImageryProvider.js#L226">Scene/ArcGisMapServerImageryProvider.js 226</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets a value indicating whether feature picking is enabled. If true, <a href="ArcGisMapServerImageryProvider.html#pickFeatures"><code>ArcGisMapServerImageryProvider#pickFeatures</code></a> will
invoke the "identify" operation on the ArcGIS server and return the features included in the response. If false,
<a href="ArcGisMapServerImageryProvider.html#pickFeatures"><code>ArcGisMapServerImageryProvider#pickFeatures</code></a> will immediately return undefined (indicating no pickable features)
without communicating with the server.
</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/ArcGisMapServerImageryProvider.js#L642">Scene/ArcGisMapServerImageryProvider.js 642</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/ArcGisMapServerImageryProvider.js#L714">Scene/ArcGisMapServerImageryProvider.js 714</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">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="layers">
<a href="#layers" class="doc-link"></a>
layers<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ArcGisMapServerImageryProvider.js#L726">Scene/ArcGisMapServerImageryProvider.js 726</a>
</div>
</h4>
</div>
<div class="description">
Gets the comma-separated list of layer IDs to show.
</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|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ArcGisMapServerImageryProvider.js#L534">Scene/ArcGisMapServerImageryProvider.js 534</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="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#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.91/Source/Scene/ArcGisMapServerImageryProvider.js#L555">Scene/ArcGisMapServerImageryProvider.js 555</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="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#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"> : <a href="Proxy.html">Proxy</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ArcGisMapServerImageryProvider.js#L479">Scene/ArcGisMapServerImageryProvider.js 479</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.91/Source/Scene/ArcGisMapServerImageryProvider.js#L654">Scene/ArcGisMapServerImageryProvider.js 654</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/ArcGisMapServerImageryProvider.js#L666">Scene/ArcGisMapServerImageryProvider.js 666</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/ArcGisMapServerImageryProvider.js#L597">Scene/ArcGisMapServerImageryProvider.js 597</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="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#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.91/Source/Scene/ArcGisMapServerImageryProvider.js#L620">Scene/ArcGisMapServerImageryProvider.js 620</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="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#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.91/Source/Scene/ArcGisMapServerImageryProvider.js#L513">Scene/ArcGisMapServerImageryProvider.js 513</a>
</div>
</h4>
</div>
<div class="description">
Gets the height of each tile, in pixels. This function should
not be called before <a href="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#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.91/Source/Scene/ArcGisMapServerImageryProvider.js#L492">Scene/ArcGisMapServerImageryProvider.js 492</a>
</div>
</h4>
</div>
<div class="description">
Gets the width of each tile, in pixels. This function should
not be called before <a href="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#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.91/Source/Scene/ArcGisMapServerImageryProvider.js#L576">Scene/ArcGisMapServerImageryProvider.js 576</a>
</div>
</h4>
</div>
<div class="description">
Gets the tiling scheme used by this provider. This function should
not be called before <a href="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="token">
<a href="#token" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> token<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ArcGisMapServerImageryProvider.js#L467">Scene/ArcGisMapServerImageryProvider.js 467</a>
</div>
</h4>
</div>
<div class="description">
Gets the ArcGIS token used to authenticate with the ArcGis MapServer service.
</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.91/Source/Scene/ArcGisMapServerImageryProvider.js#L455">Scene/ArcGisMapServerImageryProvider.js 455</a>
</div>
</h4>
</div>
<div class="description">
Gets the URL of the ArcGIS MapServer.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="usingPrecachedTiles">
<a href="#usingPrecachedTiles" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> usingPrecachedTiles<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ArcGisMapServerImageryProvider.js#L696">Scene/ArcGisMapServerImageryProvider.js 696</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating whether this imagery provider is using pre-cached tiles from the
ArcGIS MapServer. If the imagery provider is not yet ready (<a href="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#ready</code></a>), this function
will return the value of `options.usePreCachedTilesIfAvailable`, even if the MapServer does
not have pre-cached tiles.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</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/ArcGisMapServerImageryProvider.js#L743">Scene/ArcGisMapServerImageryProvider.js 743</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/ArcGisMapServerImageryProvider.js#L802">Scene/ArcGisMapServerImageryProvider.js 802</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.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: <code>pickFeatures</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="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/ArcGisMapServerImageryProvider.js#L766">Scene/ArcGisMapServerImageryProvider.js 766</a>
</div>
</h4>
</div>
<div class="description">
Requests the image for a given tile. This function should
not be called before <a href="ArcGisMapServerImageryProvider.html#ready"><code>ArcGisMapServerImageryProvider#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>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".ConstructorOptions">
<a href="#.ConstructorOptions" class="doc-link"></a>
Cesium.ArcGisMapServerImageryProvider.ConstructorOptions
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ArcGisMapServerImageryProvider.js#L23">Scene/ArcGisMapServerImageryProvider.js 23</a>
</div>
</h4>
</div>
<div class="description">
Initialization options for the ArcGisMapServerImageryProvider 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>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 of the ArcGIS MapServer service.</td>
</tr>
<tr>
<td class="name"><code>token</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The ArcGIS token used to authenticate with the ArcGIS MapServer service.</td>
</tr>
<tr>
<td class="name"><code>tileDiscardPolicy</code></td>
<td class="type">
<span class="param-type"><a href="TileDiscardPolicy.html">TileDiscardPolicy</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The policy that determines if a tile
is invalid and should be discarded. If this value is not specified, a default
<a href="DiscardMissingTileImagePolicy.html"><code>DiscardMissingTileImagePolicy</code></a> is used for tiled map servers, and a
<a href="NeverTileDiscardPolicy.html"><code>NeverTileDiscardPolicy</code></a> is used for non-tiled map servers. In the former case,
we request tile 0,0 at the maximum tile level and check pixels (0,0), (200,20), (20,200),
(80,110), and (160, 130). If all of these pixels are transparent, the discard check is
disabled and no tiles are discarded. If any of them have a non-transparent color, any
tile that has the same values in these pixel locations is discarded. The end result of
these defaults should be correct tile discarding for a standard ArcGIS Server. To ensure
that no tiles are discarded, construct and pass a <a href="NeverTileDiscardPolicy.html"><code>NeverTileDiscardPolicy</code></a> for this
parameter.</td>
</tr>
<tr>
<td class="name"><code>usePreCachedTilesIfAvailable</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, the server's pre-cached
tiles are used if they are available. If false, any pre-cached tiles are ignored and the
'export' service is used.</td>
</tr>
<tr>
<td class="name"><code>layers</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">A comma-separated list of the layers to show, or undefined if all layers should be shown.</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="ArcGisMapServerImageryProvider.html#pickFeatures"><code>ArcGisMapServerImageryProvider#pickFeatures</code></a> will invoke
the Identify service on the MapServer and return the features included in the response. If false,
<a href="ArcGisMapServerImageryProvider.html#pickFeatures"><code>ArcGisMapServerImageryProvider#pickFeatures</code></a> will immediately return undefined (indicating no pickable features)
without communicating with the server. Set this property to false if you don't want this provider's features to
be pickable. Can be overridden by setting the <a href="ArcGisMapServerImageryProvider.html#enablePickFeatures"><code>ArcGisMapServerImageryProvider#enablePickFeatures</code></a> property on the object.</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 of the layer. This parameter is ignored when accessing
a tiled layer.</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">
new GeographicTilingScheme()
</td>
<td class="description last">The tiling scheme to use to divide the world into tiles.
This parameter is ignored when accessing a tiled server.</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 and used,
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>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. This parameter is ignored when accessing a tiled server.</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">The width of each tile in pixels. This parameter is ignored when accessing a tiled server.</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">The height of each tile in pixels. This parameter is ignored when accessing a tiled server.</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 tile level to request, or undefined if there is no maximum. This parameter is ignored when accessing
a tiled server.</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>