TileCoordinatesImageryProvider

new Cesium.TileCoordinatesImageryProvider(options)

An ImageryProvider that draws a box around every rendered tile in the tiling scheme, and draws a label inside it indicating the X, Y, Level coordinates of the tile. This is mostly useful for debugging terrain and imagery rendering problems.
Name Type Description
options TileCoordinatesImageryProvider.ConstructorOptions optional Object describing initialization options

Members

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.
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.
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. Setting this property to false reduces memory usage and texture upload time.

readonly maximumLevel : number|undefined

Gets the maximum level-of-detail that can be requested.
Gets the minimum level-of-detail that can be requested.
Gets the proxy used by this provider.
Gets the rectangle, in radians, of the imagery provided by this instance.
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.
Gets the height of each tile, in pixels.
Gets the width of each tile, in pixels.
Gets the tiling scheme used by this provider.

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.

pickFeatures(x, y, level, longitude, latitude)undefined

Picking features is not currently supported by this imagery provider, so this function simply 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 is not supported.

requestImage(x, y, level, request)Promise.<HTMLCanvasElement>

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 optional The request object. Intended for internal use only.
Returns:
The resolved image as a Canvas DOM object.

Type Definitions

Cesium.TileCoordinatesImageryProvider.ConstructorOptions

Initialization options for the TileCoordinatesImageryProvider constructor
Properties:
Name Type Attributes Default Description
tilingScheme TilingScheme <optional>
new GeographicTilingScheme() The tiling scheme for which to draw tiles.
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.
color Color <optional>
Color.YELLOW The color to draw the tile box and label.
tileWidth number <optional>
256 The width of the tile for level-of-detail selection purposes.
tileHeight number <optional>
256 The height of the tile for level-of-detail selection purposes.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.