new ArcGisMapServerImageryProvider()
Provides tiled imagery hosted by an ArcGIS MapServer. By default, the server's pre-cached tiles are
used, if available.
| Name | Type | Default | Description |
|---|---|---|---|
options.url |
String | The URL of the ArcGIS MapServer service. | |
options.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. |
|
options.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. | |
options.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:
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#readyreturns 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. -
hasAlphaChannel :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.
-
maximumLevel :Number
-
Gets the maximum level-of-detail that can be requested. This function should not be called before
ArcGisMapServerImageryProvider#readyreturns true. -
minimumLevel :Number
-
Gets the minimum level-of-detail that can be requested. This function should not be called before
ArcGisMapServerImageryProvider#readyreturns 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.
-
rectangle :Rectangle
-
Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before
ArcGisMapServerImageryProvider#readyreturns true. -
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#readyreturns true. -
tileHeight :Number
-
Gets the height of each tile, in pixels. This function should not be called before
ArcGisMapServerImageryProvider#readyreturns true. -
tileWidth :Number
-
Gets the width of each tile, in pixels. This function should not be called before
ArcGisMapServerImageryProvider#readyreturns true. -
tilingScheme :TilingScheme
-
Gets the tiling scheme used by this provider. This function should not be called before
ArcGisMapServerImageryProvider#readyreturns 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 `options.usePreCachedTilesIfAvailable`, even if the MapServer does not have pre-cached tiles.
Methods
-
getTileCredits(x, y, level) → Credit[]
-
Gets the credits to be displayed when a given tile is displayed.
Name Type Description xNumber The tile X coordinate. yNumber The tile Y coordinate. levelNumber The tile level; Returns:
The credits to be displayed when the tile is displayed.Throws:
-
DeveloperError :
getTileCreditsmust not be called before the imagery provider is ready.
-
-
requestImage(x, y, level) → Promise
-
Requests the image for a given tile. This function should not be called before
ArcGisMapServerImageryProvider#readyreturns true.Name Type Description xNumber The tile X coordinate. yNumber The tile Y coordinate. levelNumber 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 :
requestImagemust not be called before the imagery provider is ready.
-