TileMapServiceImageryProvider

new Cesium.TileMapServiceImageryProvider(options)
engine/Source/Scene/TileMapServiceImageryProvider.js 78

To construct a TileMapServiceImageryProvider, call TileMapServiceImageryProvider.fromUrl. Do not call the constructor directly.
An imagery provider that provides tiled imagery as generated by MapTiler, GDAL2Tiles, etc.
Name Type Description
options TileMapServiceImageryProvider.ConstructorOptions Object describing initialization options
Example:
const tms = await Cesium.TileMapServiceImageryProvider.fromUrl(
   "../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:

Extends

Members

readonly credit : Credit
engine/Source/Scene/UrlTemplateImageryProvider.js 527

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.
Inherited From:
Default Value: undefined

deprecated defaultAlpha : Number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 557

The default alpha blending value of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.
Inherited From:

Deprecated: true

deprecated defaultBrightness : Number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 629

The default brightness of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter.
Inherited From:

Deprecated: true

deprecated defaultContrast : Number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 653

The default contrast of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the contrast while greater than 1.0 increases it.
Inherited From:

Deprecated: true

deprecated defaultDayAlpha : Number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 605

The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.
Inherited From:

Deprecated: true

deprecated defaultGamma : Number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 723

The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.
Inherited From:

Deprecated: true

deprecated defaultHue : Number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 676

The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
Inherited From:

Deprecated: true

deprecated defaultMagnificationFilter : TextureMagnificationFilter
engine/Source/Scene/UrlTemplateImageryProvider.js 769

The default texture magnification filter to apply to this provider.
Inherited From:

Deprecated: true

deprecated defaultMinificationFilter : TextureMinificationFilter
engine/Source/Scene/UrlTemplateImageryProvider.js 746

The default texture minification filter to apply to this provider.
Inherited From:

Deprecated: true

deprecated defaultNightAlpha : Number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 581

The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.
Inherited From:

Deprecated: true

deprecated defaultSaturation : Number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 700

The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the saturation while greater than 1.0 increases it.
Inherited From:

Deprecated: true

enablePickFeatures : boolean
engine/Source/Scene/UrlTemplateImageryProvider.js 280

Gets or sets a value indicating whether feature picking is enabled. If true, UrlTemplateImageryProvider#pickFeatures will request the options.pickFeaturesUrl and attempt to interpret the features included in the response. If false, UrlTemplateImageryProvider#pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you know your data source does not support picking features or if you don't want this provider's features to be pickable.
Inherited From:
Default Value: true

readonly errorEvent : Event
engine/Source/Scene/UrlTemplateImageryProvider.js 479

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.
Inherited From:

readonly hasAlphaChannel : boolean
engine/Source/Scene/UrlTemplateImageryProvider.js 544

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.
Inherited From:
Default Value: true

readonly maximumLevel : number|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 411

Gets the maximum level-of-detail that can be requested, or undefined if there is no limit.
Inherited From:
Default Value: undefined

readonly minimumLevel : number
engine/Source/Scene/UrlTemplateImageryProvider.js 424

Gets the minimum level-of-detail that can be requested.
Inherited From:
Default Value: 0

readonly pickFeaturesUrl : string
engine/Source/Scene/UrlTemplateImageryProvider.js 359

Gets the URL template to use to use to pick features. If this property is not specified, UrlTemplateImageryProvider#pickFeatures will immediately return undefined, indicating no features picked. The URL template supports all of the keywords supported by the UrlTemplateImageryProvider#url property, plus the following:
  • {i}: The pixel column (horizontal coordinate) of the picked position, where the Westernmost pixel is 0.
  • {j}: The pixel row (vertical coordinate) of the picked position, where the Northernmost pixel is 0.
  • {reverseI}: The pixel column (horizontal coordinate) of the picked position, where the Easternmost pixel is 0.
  • {reverseJ}: The pixel row (vertical coordinate) of the picked position, where the Southernmost pixel is 0.
  • {longitudeDegrees}: The longitude of the picked position in degrees.
  • {latitudeDegrees}: The latitude of the picked position in degrees.
  • {longitudeProjected}: The longitude of the picked position in the projected coordinates of the tiling scheme.
  • {latitudeProjected}: The latitude of the picked position in the projected coordinates of the tiling scheme.
  • {format}: The format in which to get feature information, as specified in the GetFeatureInfoFormat.
Inherited From:

readonly proxy : Proxy
engine/Source/Scene/UrlTemplateImageryProvider.js 372

Gets the proxy used by this provider.
Inherited From:
Default Value: undefined

readonly deprecated ready : boolean
engine/Source/Scene/UrlTemplateImageryProvider.js 492

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

Deprecated: true

readonly deprecated readyPromise : Promise.<boolean>
engine/Source/Scene/UrlTemplateImageryProvider.js 509

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

Deprecated: true

readonly rectangle : Rectangle
engine/Source/Scene/UrlTemplateImageryProvider.js 450

Gets the rectangle, in radians, of the imagery provided by this instance.
Inherited From:
Default Value: tilingScheme.rectangle

readonly tileDiscardPolicy : TileDiscardPolicy
engine/Source/Scene/UrlTemplateImageryProvider.js 465

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.
Inherited From:
Default Value: undefined

readonly tileHeight : number
engine/Source/Scene/UrlTemplateImageryProvider.js 398

Gets the height of each tile, in pixels.
Inherited From:
Default Value: 256

readonly tileWidth : number
engine/Source/Scene/UrlTemplateImageryProvider.js 385

Gets the width of each tile, in pixels.
Inherited From:
Default Value: 256

readonly tilingScheme : TilingScheme
engine/Source/Scene/UrlTemplateImageryProvider.js 437

Gets the tiling scheme used by this provider.
Inherited From:
Default Value: new WebMercatorTilingScheme()

readonly url : string
engine/Source/Scene/UrlTemplateImageryProvider.js 309

Gets the URL template to use to request tiles. It has the following keywords:
  • {z}: The level of the tile in the tiling scheme. Level zero is the root of the quadtree pyramid.
  • {x}: The tile X coordinate in the tiling scheme, where 0 is the Westernmost tile.
  • {y}: The tile Y coordinate in the tiling scheme, where 0 is the Northernmost tile.
  • {s}: One of the available subdomains, used to overcome browser limits on the number of simultaneous requests per host.
  • {reverseX}: The tile X coordinate in the tiling scheme, where 0 is the Easternmost tile.
  • {reverseY}: The tile Y coordinate in the tiling scheme, where 0 is the Southernmost tile.
  • {reverseZ}: The level of the tile in the tiling scheme, where level zero is the maximum level of the quadtree pyramid. In order to use reverseZ, maximumLevel must be defined.
  • {westDegrees}: The Western edge of the tile in geodetic degrees.
  • {southDegrees}: The Southern edge of the tile in geodetic degrees.
  • {eastDegrees}: The Eastern edge of the tile in geodetic degrees.
  • {northDegrees}: The Northern edge of the tile in geodetic degrees.
  • {westProjected}: The Western edge of the tile in projected coordinates of the tiling scheme.
  • {southProjected}: The Southern edge of the tile in projected coordinates of the tiling scheme.
  • {eastProjected}: The Eastern edge of the tile in projected coordinates of the tiling scheme.
  • {northProjected}: The Northern edge of the tile in projected coordinates of the tiling scheme.
  • {width}: The width of each tile in pixels.
  • {height}: The height of each tile in pixels.
Inherited From:

readonly urlSchemeZeroPadding : object
engine/Source/Scene/UrlTemplateImageryProvider.js 333

Gets the URL scheme zero padding for each tile coordinate. The format is '000' where each coordinate will be padded on the left with zeros to match the width of the passed string of zeros. e.g. Setting: urlSchemeZeroPadding : { '{x}' : '0000'} will cause an 'x' value of 12 to return the string '0012' for {x} in the generated URL. It has the following keywords:
  • {z}: The zero padding for the level of the tile in the tiling scheme.
  • {x}: The zero padding for the tile X coordinate in the tiling scheme.
  • {y}: The zero padding for the the tile Y coordinate in the tiling scheme.
  • {reverseX}: The zero padding for the tile reverseX coordinate in the tiling scheme.
  • {reverseY}: The zero padding for the tile reverseY coordinate in the tiling scheme.
  • {reverseZ}: The zero padding for the reverseZ coordinate of the tile in the tiling scheme.
Inherited From:

Methods

static Cesium.TileMapServiceImageryProvider.fromUrl(url, options) → Promise.<TileMapServiceImageryProvider>
engine/Source/Scene/TileMapServiceImageryProvider.js 170

Creates a TileMapServiceImageryProvider from the specified url.
Name Type Description
url Resource | String Path to image tiles on server.
options TileMapServiceImageryProvider.ConstructorOptions optional Object describing initialization options.
Returns:
A promise that resolves to the created TileMapServiceImageryProvider.
Throws:
  • RuntimeError : Unable to find expected tilesets or bbox attributes in tilemapresource.xml
  • RuntimeError : tilemapresource.xml specifies an unsupported profile attribute
Example:
const tms = await Cesium.TileMapServiceImageryProvider.fromUrl(
   '../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))
});

getTileCredits(x, y, level) → Array.<Credit>
engine/Source/Scene/UrlTemplateImageryProvider.js 889

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.
Inherited From:

pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 927

Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile.
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.
Inherited From:

deprecated reinitialize(options)
engine/Source/Scene/UrlTemplateImageryProvider.js 794

Reinitializes this instance. Reinitializing an instance already in use is supported, but it is not recommended because existing tiles provided by the imagery provider will not be updated.
Name Type Description
options Promise.<object> | object Any of the options that may be passed to the UrlTemplateImageryProvider constructor.
Inherited From:

Deprecated: true

requestImage(x, y, level, request) → Promise.<ImageryTypes>|undefined
engine/Source/Scene/UrlTemplateImageryProvider.js 901

Name Type Description
x number The tile X coordinate.
y number The tile Y coordinate.
level number The tile level.
request Request optional The request object. Intended for internal use only.
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.
Inherited From:

Type Definitions

Cesium.TileMapServiceImageryProvider.ConstructorOptions
engine/Source/Scene/TileMapServiceImageryProvider.js 17

Initialization options for the TileMapServiceImageryProvider constructor
Properties:
Name Type Attributes Default Description
url Resource | string | Promise.<Resource> | Promise.<string> <optional>
 Path to image tiles on server. Deprecated
fileExtension string <optional>
 'png' The file extension for images on the server.
credit Credit | string <optional>
 '' A credit for the data source, which is displayed on the canvas.
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.
maximumLevel number <optional>
 The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
rectangle Rectangle <optional>
 Rectangle.MAX_VALUE 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 <optional>
 256 Pixel width of image tiles.
tileHeight number <optional>
 256 Pixel height of image tiles.
flipXY boolean <optional>
 Older versions of gdal2tiles.py flipped X and Y values in tilemapresource.xml.
tileDiscardPolicy TileDiscardPolicy <optional>
 A policy for discarding tile images according to some criteria Specifying this option will do the same, allowing for loading of these incorrect tilesets.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets