new TileCoordinatesImageryProvider()
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 | Default | Description |
|---|---|---|---|
options.tilingScheme |
TilingScheme |
new GeographicTilingScheme()
|
optional The tiling scheme for which to draw tiles. |
options.color |
Color |
Color.YELLOW
|
optional The color to draw the tile box and label. |
options.tileWidth |
Number |
256
|
optional The width of the tile for level-of-detail selection purposes. |
options.tileHeight |
Number |
256
|
optional The height of the tile for level-of-detail selection purposes. |
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
TileCoordinatesImageryProvider#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. Setting this property to false reduces memory usage and texture upload time.
-
maximumLevel :Number
-
Gets the maximum level-of-detail that can be requested. This function should not be called before
TileCoordinatesImageryProvider#readyreturns true. -
minimumLevel :Number
-
Gets the minimum level-of-detail that can be requested. This function should not be called before
TileCoordinatesImageryProvider#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
TileCoordinatesImageryProvider#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
TileCoordinatesImageryProvider#readyreturns true. -
tileHeight :Number
-
Gets the height of each tile, in pixels. This function should not be called before
TileCoordinatesImageryProvider#readyreturns true. -
tileWidth :Number
-
Gets the width of each tile, in pixels. This function should not be called before
TileCoordinatesImageryProvider#readyreturns true. -
tilingScheme :TilingScheme
-
Gets the tiling scheme used by this provider. This function should not be called before
TileCoordinatesImageryProvider#readyreturns true.
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
TileCoordinatesImageryProvider#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.