TileMapServiceImageryProvider

new TileMapServiceImageryProvider()

Provides tiled imagery as generated by GDDAL2Tiles etc.
Name Type Default Description
options.url String '.' optional Path to image tiles on server.
options.fileExtension String 'png' optional The file extension for images on the server.
options.proxy Object optional A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
options.credit Credit | String '' optional A credit for the data source, which is displayed on the canvas.
options.minimumLevel Number 0 optional 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.
options.maximumLevel Number 18 optional The maximum level-of-detail supported by the imagery provider.
options.rectangle Rectangle Rectangle.MAX_VALUE optional The rectangle, in radians, covered by the image.
options.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.
options.tileWidth Number 256 optional Pixel width of image tiles.
options.tileHeight Number 256 optional Pixel height of image tiles.
Example:
// TileMapService tile provider
var tms = new Cesium.TileMapServiceImageryProvider({
   url : '../images/cesium_maptiler/Cesium_Logo_Color',
   fileExtension: 'png',
   maximumLevel: 4,
   rectangle: new Cesium.Rectangle(
       Cesium.Math.toRadians(-120.0),
       Cesium.Math.toRadians(20.0),
       Cesium.Math.toRadians(-60.0),
       Cesium.Math.toRadians(40.0))
});
See:
Source: Scene/TileMapServiceImageryProvider.js, line 77

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 TileMapServiceImageryProvider#ready returns true.
Source: Scene/TileMapServiceImageryProvider.js, line 391

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.
Source: Scene/TileMapServiceImageryProvider.js, line 368

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. When this property is false, memory usage and texture upload time are reduced.
Source: Scene/TileMapServiceImageryProvider.js, line 406

maximumLevel :Number

Gets the maximum level-of-detail that can be requested. This function should not be called before TileMapServiceImageryProvider#ready returns true.
Source: Scene/TileMapServiceImageryProvider.js, line 275

minimumLevel :Number

Gets the minimum level-of-detail that can be requested. This function should not be called before TileMapServiceImageryProvider#ready returns true.
Source: Scene/TileMapServiceImageryProvider.js, line 293

proxy :Proxy

Gets the proxy used by this provider.
Source: Scene/TileMapServiceImageryProvider.js, line 227

ready :Boolean

Gets a value indicating whether or not the provider is ready for use.
Source: Scene/TileMapServiceImageryProvider.js, line 379

rectangle :Rectangle

Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before TileMapServiceImageryProvider#ready returns true.
Source: Scene/TileMapServiceImageryProvider.js, line 329

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 TileMapServiceImageryProvider#ready returns true.
Source: Scene/TileMapServiceImageryProvider.js, line 349

tileHeight :Number

Gets the height of each tile, in pixels. This function should not be called before TileMapServiceImageryProvider#ready returns true.
Source: Scene/TileMapServiceImageryProvider.js, line 257

tileWidth :Number

Gets the width of each tile, in pixels. This function should not be called before TileMapServiceImageryProvider#ready returns true.
Source: Scene/TileMapServiceImageryProvider.js, line 239

tilingScheme :TilingScheme

Gets the tiling scheme used by this provider. This function should not be called before TileMapServiceImageryProvider#ready returns true.
Source: Scene/TileMapServiceImageryProvider.js, line 311

url :String

Gets the URL of the service hosting the imagery.
Source: Scene/TileMapServiceImageryProvider.js, line 216

Methods

getTileCredits(x, y, level) → 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.
Throws:
  • DeveloperError : getTileCredits must not be called before the imagery provider is ready.
Source: Scene/TileMapServiceImageryProvider.js, line 426

requestImage(x, y, level) → Promise

Requests the image for a given tile. This function should not be called before TileMapServiceImageryProvider#ready returns true.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number 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.
Source: Scene/TileMapServiceImageryProvider.js, line 445