EmbeddedTileServiceImageryProvider

new Cesium.EmbeddedTileServiceImageryProvider(options)
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 32

Name Type Description
options Object Object with the following properties:
Name Type Description
id String The ID of the embedded imagery.
path String The path to the embedded imagery.
credit String | Credit optional A credit for the imagery.
Example:
let imageryProvider = new EmbeddedTileServiceImageryProvider({
   id: "BlueMarble",
   path: "200406",
});

Members

static readonly Cesium.EmbeddedTileServiceImageryProvider.availableLayers : Array.<Object>
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 376

clock : Clock
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 269

Gets or sets the clock instance used for time dynamic imagery.

readonly credit : Credit
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 246

Gets the credit to display when this imagery provider is active.

readonly errorEvent : Event
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 200

Gets an event that is raised when the imagery provider encounters an asynchronous error.

readonly format : String
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 212

Gets the format of the imagery tiles.

readonly hasAlphaChannel : Boolean
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 258

Gets a value indicating whether the images provided by this imagery provider include an alpha channel.

readonly maximumLevel : Number
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 140

Gets the maximum zoom level.

readonly minimumLevel : Number
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 152

Gets the minimum zoom level.

readonly proxy : Proxy
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 298

Gets the proxy used by this provider.

readonly ready : Boolean
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 224

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

readonly readyPromise : Promise.<Boolean>
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 234

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

readonly rectangle : Rectangle
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 176

Gets the rectangle, in radians, covered by this imagery provider.

readonly tileDiscardPolicy : TileDiscardPolicy
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 188

Gets the tile discard policy.

readonly tileHeight : Number
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 128

Gets the height of each tile, in pixels.

readonly tileWidth : Number
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 116

Gets the width of each tile, in pixels.

readonly tilingScheme : TilingScheme
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 164

Gets the tiling scheme used by this provider.

times : TimeIntervalCollection
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 283

Gets or sets the time intervals used for time dynamic imagery.

readonly url : String
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 104

Gets the URL of the imagery service.

Methods

getTileCredits(x, y, level) → Array.<Credit>
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 313

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.

pickFeatures(x, y, level, longitude, latitude) → undefined
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 331

Picking features is not currently supported by this imagery provider, so this function always 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:
Undefined since picking features is not supported.

requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
engine/Source/Scene/EmbeddedTileServiceImageryProvider.js 350

Requests the image for a given tile.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
request Request The request object.
Returns:
A promise to an image or undefined if the image cannot be requested.
Need help? [email protected]
OrbPro
packages/engine
packages/widgets