top
all js glsl

TileMapServiceImageryProvider

TileMapServiceImageryProvider

new

Provides tiled imagery as generated by MapTiler / GDDAL2Tiles etc.

Parameters:
Name Type Argument Default Description
description.url String <optional>
 '.' Path to image tiles on server.
description.fileExtension String <optional>
 'png' The file extension for images on the server.
description.proxy Object <optional>
 A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
description.credit Credit | String <optional>
 '' A credit for the data source, which is displayed on the canvas.
description.minimumLevel Number <optional>
 0 The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.
description.maximumLevel Number <optional>
 18 The maximum level-of-detail supported by the imagery provider.
description.extent Extent <optional>
 Extent.MAX_VALUE The extent, in radians, covered by the image.
description.tilingScheme TilingScheme <optional>
 The tiling scheme specifying how the ellipsoidal surface is broken into tiles. If this parameter is not provided, a WebMercatorTilingScheme is used.
description.tileWidth Number <optional>
 256 Pixel width of image tiles.
description.tileHeight Number <optional>
 256 Pixel height of image tiles.
Example
// TileMapService tile provider
var tms = new TileMapServiceImageryProvider({
   url : '../images/cesium_maptiler/Cesium_Logo_Color',
   fileExtension: 'png',
   maximumLevel: 4,
   extent: new Cesium.Extent(
       Cesium.Math.toRadians(-120.0),
       Cesium.Math.toRadians(20.0),
       Cesium.Math.toRadians(-60.0),
       Cesium.Math.toRadians(40.0))
});
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 TileMapServiceImageryProvider#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 TileMapServiceImageryProvider#isReady returns true.

Returns:
Extent The extent.

Gets the maximum level-of-detail that can be requested. This function should not be called before TileMapServiceImageryProvider#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 TileMapServiceImageryProvider#isReady returns true.

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

Returns:
TileDiscardPolicy The discard policy.
See:

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

Returns:
Number The height.

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

Returns:
Number The width.

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

Returns:
TilingScheme The tiling scheme.
See:

Gets the URL of the service hosting the imagery.

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 TileMapServiceImageryProvider#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.