ArcGisMapServerImageryProvider - Cesium Documentation

# 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.
  `token` | String |  | optional The ArcGIS token used to authenticate with 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.
  `layers` | String |  | optional A comma-separated list of the layers to show, or undefined if all layers should be shown.
  `enablePickFeatures` | Boolean | `true` | optional If true, `ArcGisMapServerImageryProvider#pickFeatures` will invoke the Identify service on the MapServer and return the features included in the response. If false, `ArcGisMapServerImageryProvider#pickFeatures` 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.
  `rectangle` | Rectangle | `Rectangle.MAX_VALUE` | optional The rectangle of the layer. This parameter is ignored when accessing a tiled layer.
  `tilingScheme` | TilingScheme | `new GeographicTilingScheme()` | optional The tiling scheme to use to divide the world into tiles. This parameter is ignored when accessing a tiled server.
  `ellipsoid` | Ellipsoid |  | optional 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.
  `tileWidth` | Number | `256` | optional The width of each tile in pixels. This parameter is ignored when accessing a tiled server.
  `tileHeight` | Number | `256` | optional The height of each tile in pixels. This parameter is ignored when accessing a tiled server.
  `maximumLevel` | Number |  | optional The maximum tile level to request, or undefined if there is no maximum. This parameter is ignored when accessing a tiled server.

  ##### Example:

      var esri = new Cesium.ArcGisMapServerImageryProvider({
          url: '//services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer'
      });

  ##### See:

  - BingMapsImageryProvider
  - GoogleEarthImageryProvider
  - OpenStreetMapImageryProvider
  - SingleTileImageryProvider
  - TileMapServiceImageryProvider
  - WebMapServiceImageryProvider
  - WebMapTileServiceImageryProvider
  - UrlTemplateImageryProvider
  - ArcGIS Server REST API
  - Cross-Origin Resource Sharing
  Source: Scene/ArcGisMapServerImageryProvider.js, line 111

### 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 476

#### 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 451

#### 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 511

#### 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 353

#### 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 372

#### readonlyproxy :Proxy

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

#### readonlyready :Boolean

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

#### 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 410

#### 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 431

#### 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 334

#### 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 315

#### 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 391

#### readonlytoken :String

  Gets the ArcGIS token used to authenticate with the ArcGis MapServer service.
  Source: Scene/ArcGisMapServerImageryProvider.js, line 290

#### readonlyurl :String

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

#### 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 493

### 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 554

#### pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined

  /** Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile. This function should not be called before `ImageryProvider#ready` returns true.

  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.

  ##### Throws:

  - DeveloperError : `pickFeatures` must not be called before the imagery provider is ready.
  Source: Scene/ArcGisMapServerImageryProvider.js, line 599

#### requestImage(x, y, level) → Promise.<(Image|Canvas)>|undefined

  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 572