top
all js glsl

SingleTileImageryProvider

SingleTileImageryProvider

new

Provides a single, top-level imagery tile. The single image is assumed to use a GeographicTilingScheme.

Parameters:
Name Type Argument Default Description
description.url String The url for the tile.
description.extent Extent <optional>
 Extent.MAX_VALUE The extent, in radians, covered by the image.
description.credit Credit | String <optional>
 A credit for the data source, which is displayed on the canvas.
description.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.
Throws:
DeveloperError : description.url is required.
See:
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 SingleTileImageryProvider#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 SingleTileImageryProvider#isReady returns true.

Returns:
Extent The extent.

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

Throws:
DeveloperError : getMaximumLevel must not be called before the imagery provider is ready.
Returns:
Number The maximum level.

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

Throws:
DeveloperError : getMinimumLevel must not be called before the imagery provider is ready.
Returns:
Number The minimum level.

Gets the proxy used by this provider.

Returns:
Proxy The proxy.
See:

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

Throws:
DeveloperError : getTileDiscardPolicy must not be called before the imagery provider is ready.
Returns:
TileDiscardPolicy The discard policy.
See:

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

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

Gets the width of each tile, in pixels. This function should not be called before SingleTileImageryProvider#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 SingleTileImageryProvider#isReady returns true.

Throws:
DeveloperError : getTilingScheme must not be called before the imagery provider is ready.
Returns:
TilingScheme The tiling scheme.
See:

Gets the URL of the single, top-level imagery tile.

Returns:
String The URL.

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

Parameters:
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
Throws:
DeveloperError : requestImage must not be called before the imagery provider is ready.
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.