top
all js glsl

TileCoordinatesImageryProvider

TileCoordinatesImageryProvider

new

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.

Parameters:
Name Type Argument Default Description
description.tilingScheme TilingScheme <optional>
 new GeographicTilingScheme() The tiling scheme for which to draw tiles.
description.color Color <optional>
 Color.YELLOW The color to draw the tile box and label.
description.tileWidth Number <optional>
 256 The width of the tile for level-of-detail selection purposes.
description.tileHeight Number <optional>
 256 The height of the tile for level-of-detail selection purposes.
Source:

Methods

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 BingMapsImageryProvider#isReady returns true.

Returns:
Credit The credit, or undefined if no credit exists

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.

Returns:
Event The event.

Gets the extent, in radians, of the imagery provided by this instance. This function should not be called before BingMapsImageryProvider#isReady returns true.

Returns:
Extent The extent.

Gets the maximum level-of-detail that can be requested. This function should not be called before TileCoordinatesImageryProvider#isReady returns true.

Returns:
Number The maximum level.

Gets the minimum level-of-detail that can be requested. This function should not be called before TileCoordinatesImageryProvider#isReady returns true.

Returns:
Number The minimum level.

Gets the proxy used by this provider.

Returns:
Proxy This provider does not use a proxy so undefined is always returned.

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 BingMapsImageryProvider#isReady returns true.

Returns:
TileDiscardPolicy The discard policy.
See:

Gets the height of each tile, in pixels. This function should not be called before BingMapsImageryProvider#isReady returns true.

Returns:
Number The height.

Gets the width of each tile, in pixels. This function should not be called before BingMapsImageryProvider#isReady returns true.

Throws:
DeveloperError : getTileWidth must not be called before the imagery provider is ready.
Returns:
Number The width.

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

Returns:
TilingScheme The tiling scheme.
See:

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

Returns:
Boolean True if the provider is ready to use; otherwise, false.

Requests the image for a given tile. This function should not be called before BingMapsImageryProvider#isReady returns true.

Parameters:
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
Returns:
Promise 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.