ArcGisImageServerTerrainProvider

new Cesium.ArcGisImageServerTerrainProvider(options)
Core/ArcGisImageServerTerrainProvider.js 66

A TerrainProvider that produces terrain geometry by tessellating height maps retrieved from an ArcGIS ImageServer.
Name Type Description
options Object Object with the following properties:
Name Type Description
url String The URL of the ArcGIS ImageServer service.
token String optional The authorization token to use to connect to the service.
proxy Object optional A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
tilingScheme TilingScheme optional The tiling scheme specifying how the terrain is broken into tiles. If this parameter is not provided, a GeographicTilingScheme is used.
ellipsoid Ellipsoid optional The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
credit Credit | String optional The credit, which will is displayed on the canvas.
Example:
var terrainProvider = new Cesium.ArcGisImageServerTerrainProvider({
  url : 'https://elevation.arcgisonline.com/ArcGIS/rest/services/WorldElevation/DTMEllipsoidal/ImageServer',
  token : 'KED1aF_I4UzXOHy3BnhwyBHU4l5oY6rO6walkmHoYqGp4XyIWUd5YZUC1ZrLAzvV40pR6gBXQayh0eFA8m6vPg..',
  proxy : new Cesium.DefaultProxy('/terrain/')
});
viewer.terrainProvider = terrainProvider;
See:

Members

credit : Credit
Core/ArcGisImageServerTerrainProvider.js 129

Gets the credit to display when this terrain provider is active. Typically this is used to credit the source of the terrain. This function should not be called before ArcGisImageServerTerrainProvider#ready returns true.

errorEvent : Event
Core/ArcGisImageServerTerrainProvider.js 117

Gets an event that is raised when the terrain 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.

hasVertexNormals : Boolean
Core/ArcGisImageServerTerrainProvider.js 190

Gets a value indicating whether or not the requested tiles include vertex normals. This function should not be called before ArcGisImageServerTerrainProvider#ready returns true.

hasWaterMask : Boolean
Core/ArcGisImageServerTerrainProvider.js 178

Gets a value indicating whether or not the provider includes a water mask. The water mask indicates which areas of the globe are water rather than land, so they can be rendered as a reflective surface with animated waves. This function should not be called before ArcGisImageServerTerrainProvider#ready returns true.

ready : Boolean
Core/ArcGisImageServerTerrainProvider.js 152

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

readonlyreadyPromise : Promise.<Boolean>
Core/ArcGisImageServerTerrainProvider.js 164

Gets a promise that resolves to true when the provider is ready for use.

tilingScheme : GeographicTilingScheme
Core/ArcGisImageServerTerrainProvider.js 141

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

Methods

getLevelMaximumGeometricError(level) → Number
Core/ArcGisImageServerTerrainProvider.js 259

Gets the maximum geometric error allowed in a tile at a given level.
Name Type Description
level Number The tile level for which to get the maximum geometric error.
Returns:
The maximum geometric error.

getTileDataAvailable(x, y, level) → Boolean
Core/ArcGisImageServerTerrainProvider.js 271

Determines whether data for a tile is available to be loaded.
Name Type Description
x Number The X coordinate of the tile for which to request geometry.
y Number The Y coordinate of the tile for which to request geometry.
level Number The level of the tile for which to request geometry.
Returns:
Undefined if not supported, otherwise true or false.

requestTileGeometry(x, y, level) → Promise.<TerrainData>|undefined
Core/ArcGisImageServerTerrainProvider.js 209

Requests the geometry for a given tile. This function should not be called before ArcGisImageServerTerrainProvider#ready returns true. The result includes terrain data and indicates that all child tiles are available.
Name Type Description
x Number The X coordinate of the tile for which to request geometry.
y Number The Y coordinate of the tile for which to request geometry.
level Number The level of the tile for which to request geometry.
Returns:
A promise for the requested geometry. If this method returns undefined instead of a promise, it is an indication that too many requests are already pending and the request will be retried later.