TileMapServiceImageryProvider

new Cesium.TileMapServiceImageryProvider(options)
Scene/TileMapServiceImageryProvider.js 92

Provides tiled imagery as generated by GDDAL2Tiles etc.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
url String '.' optional Path to image tiles on server.
fileExtension String 'png' optional The file extension for images on the server.
proxy Object optional A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
credit Credit | String '' optional A credit for the data source, which is displayed on the canvas.
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.
maximumLevel Number optional The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
rectangle Rectangle Rectangle.MAX_VALUE optional The rectangle, in radians, covered by the image.
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.
ellipsoid Ellipsoid optional The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
tileWidth Number 256 optional Pixel width of image tiles.
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:

Members

readonlycredit : Credit
Scene/TileMapServiceImageryProvider.js 496

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.

readonlyerrorEvent : Event
Scene/TileMapServiceImageryProvider.js 459

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.

readonlyhasAlphaChannel : Boolean
Scene/TileMapServiceImageryProvider.js 512

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.

readonlymaximumLevel : Number
Scene/TileMapServiceImageryProvider.js 361

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

readonlyminimumLevel : Number
Scene/TileMapServiceImageryProvider.js 380

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

readonlyproxy : Proxy
Scene/TileMapServiceImageryProvider.js 310

Gets the proxy used by this provider.

readonlyready : Boolean
Scene/TileMapServiceImageryProvider.js 471

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

readonlyreadyPromise : Promise.<Boolean>
Scene/TileMapServiceImageryProvider.js 483

Gets a promise that resolves to true when the provider is ready for use.

readonlyrectangle : Rectangle
Scene/TileMapServiceImageryProvider.js 418

Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before TileMapServiceImageryProvider#ready returns true.

readonlytileDiscardPolicy : TileDiscardPolicy
Scene/TileMapServiceImageryProvider.js 439

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.

readonlytileHeight : Number
Scene/TileMapServiceImageryProvider.js 342

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

readonlytileWidth : Number
Scene/TileMapServiceImageryProvider.js 323

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

readonlytilingScheme : TilingScheme
Scene/TileMapServiceImageryProvider.js 399

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

readonlyurl : String
Scene/TileMapServiceImageryProvider.js 298

Gets the URL of the service hosting the imagery.

Methods

getTileCredits(x, y, level) → Array.<Credit>
Scene/TileMapServiceImageryProvider.js 529

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.

pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
Scene/TileMapServiceImageryProvider.js 570

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
longitude Number The longitude at which to pick features.
latitude Number The latitude at which to pick features.
Returns:
A promise for the picked features that will resolve when the asynchronous picking completes. The resolved value is an array of ImageryLayerFeatureInfo instances. The array may be empty if no features are found at the given location. It may also be undefined if picking is not supported.

requestImage(x, y, level) → Promise.<(Image|Canvas)>|undefined
Scene/TileMapServiceImageryProvider.js 545

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.