ArcGisMapServerImageryProvider

new ArcGisMapServerImageryProvider(options)

Provides tiled imagery hosted by an ArcGIS MapServer. By default, the server's pre-cached tiles are used, if available.
Name Type Description
options Object Object with the following properties:
Name Type Default Description
url String The URL of the ArcGIS MapServer service.
tileDiscardPolicy TileDiscardPolicy optional The policy that determines if a tile is invalid and should be discarded. If this value is not specified, a default DiscardMissingTileImagePolicy is used for tiled map servers, and a NeverTileDiscardPolicy 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 NeverTileDiscardPolicy for this parameter.
proxy Proxy optional A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
usePreCachedTilesIfAvailable Boolean true optional 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.
Example:
var esri = new Cesium.ArcGisMapServerImageryProvider({
    url: '//services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer'
});
See:
Source: Scene/ArcGisMapServerImageryProvider.js, line 81

Members

readonlycredit :Credit

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 ArcGisMapServerImageryProvider#ready returns true.
Source: Scene/ArcGisMapServerImageryProvider.js, line 409

readonlyerrorEvent :Event

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 TileProviderError.
Source: Scene/ArcGisMapServerImageryProvider.js, line 384

readonlyhasAlphaChannel :Boolean

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.
Default Value: true
Source: Scene/ArcGisMapServerImageryProvider.js, line 444

readonlymaximumLevel :Number

Gets the maximum level-of-detail that can be requested. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.
Source: Scene/ArcGisMapServerImageryProvider.js, line 286

readonlyminimumLevel :Number

Gets the minimum level-of-detail that can be requested. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.
Source: Scene/ArcGisMapServerImageryProvider.js, line 305

readonlyproxy :Proxy

Gets the proxy used by this provider.
Source: Scene/ArcGisMapServerImageryProvider.js, line 235

readonlyready :Boolean

Gets a value indicating whether or not the provider is ready for use.
Source: Scene/ArcGisMapServerImageryProvider.js, line 396

readonlyrectangle :Rectangle

Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.
Source: Scene/ArcGisMapServerImageryProvider.js, line 343

readonlytileDiscardPolicy :TileDiscardPolicy

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 ArcGisMapServerImageryProvider#ready returns true.
Source: Scene/ArcGisMapServerImageryProvider.js, line 364

readonlytileHeight :Number

Gets the height of each tile, in pixels. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.
Source: Scene/ArcGisMapServerImageryProvider.js, line 267

readonlytileWidth :Number

Gets the width of each tile, in pixels. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.
Source: Scene/ArcGisMapServerImageryProvider.js, line 248

readonlytilingScheme :TilingScheme

Gets the tiling scheme used by this provider. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.
Source: Scene/ArcGisMapServerImageryProvider.js, line 324

readonlyurl :String

Gets the URL of the ArcGIS MapServer.
Source: Scene/ArcGisMapServerImageryProvider.js, line 223

readonlyusingPrecachedTiles :Boolean

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 (ArcGisMapServerImageryProvider#ready), this function will return the value of `options.usePreCachedTilesIfAvailable`, even if the MapServer does not have pre-cached tiles.
Default Value: true
Source: Scene/ArcGisMapServerImageryProvider.js, line 426

Methods

getTileCredits(x, y, level) → Array.<Credit>

Gets the credits to be displayed when a given tile is displayed.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level;
Returns:
The credits to be displayed when the tile is displayed.
Throws:
  • DeveloperError : getTileCredits must not be called before the imagery provider is ready.
Source: Scene/ArcGisMapServerImageryProvider.js, line 462

pickFeatures(x, y, level, longitude, latitude) → Promise

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
longitude Number The longitude at which to pick features.
latitude Number The latitude at which to pick features.
Returns:
A promise for the picked features that will resolve when the asynchronous picking completes. The resolved value is an array of ImageryLayerFeatureInfo instances. The array may be empty if no features are found at the given location. It may also be undefined if picking is not supported.
Source: Scene/ArcGisMapServerImageryProvider.js, line 505

requestImage(x, y, level) → Promise

Requests the image for a given tile. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
Returns:
A promise for the image that will resolve when the image is available, or undefined if there are too many active requests to the server, and the request should be retried later. The resolved image may be either an Image or a Canvas DOM object.
Throws:
  • DeveloperError : requestImage must not be called before the imagery provider is ready.
Source: Scene/ArcGisMapServerImageryProvider.js, line 480