ArcGisMapServerImageryProvider

new ArcGisMapServerImageryProvider

Provides tiled imagery hosted by an ArcGIS MapServer. By default, the server's pre-cached tiles are used, if available.

Parameters:

Name	Type	Argument	Default	Description
`description.url`	String			The URL of the ArcGIS MapServer service.
`description.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.
`description.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.
`description.usePreCachedTilesIfAvailable`	Boolean	<optional>	true	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: 'http://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer'
});

See:

Source:

/Source/Scene/ArcGisMapServerImageryProvider.js

Members

credit :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.

errorEvent :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.

extent :Extent

Gets the extent, in radians, of the imagery provided by this instance. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.

maximumLevel :Number

Gets the maximum level-of-detail that can be requested. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.

minimumLevel :Number

Gets the minimum level-of-detail that can be requested. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.

proxy :Proxy

Gets the proxy used by this provider.

ready :Boolean

Gets a value indicating whether or not the provider is ready for use.

tileDiscardPolicy :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.

tileHeight :Number

Gets the height of each tile, in pixels. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.

tileWidth :Number

Gets the width of each tile, in pixels. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.

tilingScheme :TilingScheme

Gets the tiling scheme used by this provider. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.

url :String

Gets the URL of the ArcGIS MapServer.

usingPrecachedTiles

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 `description.usePreCachedTilesIfAvailable`, even if the MapServer does not have pre-cached tiles.

Methods

getTileCredits

Gets the credits to be displayed when a given tile is displayed.

Parameters:

Name	Type	Description
`x`	Number	The tile X coordinate.
`y`	Number	The tile Y coordinate.
`level`	Number	The tile level;

Throws:

DeveloperError : getTileCredits must not be called before the imagery provider is ready.

Returns:

Credit[] The credits to be displayed when the tile is displayed.

requestImage

Requests the image for a given tile. This function should not be called before ArcGisMapServerImageryProvider#ready returns true.

Parameters:

Name	Type	Description
`x`	Number	The tile X coordinate.
`y`	Number	The tile Y coordinate.
`level`	Number	The tile level.

Throws:

DeveloperError : requestImage must not be called before the imagery provider is ready.

Returns:

Promise 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.