UrlTemplateImageryProvider

new Cesium.UrlTemplateImageryProvider(options)

Provides imagery by requesting tiles using a specified URL template.
Name Type Description
options Promise.<Object> | Object optional Object with the following properties:
Name Type Default Description
url String 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.
pickFeaturesUrl String optional The URL template to use to pick features. If this property is not specified, UrlTemplateImageryProvider#pickFeatures will immediately returned undefined, indicating no features picked. The URL template supports all of the keywords supported by the url parameter, 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.
urlSchemeZeroPadding Object optional 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 the passed object 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.
subdomains String | Array.<String> 'abc' optional The subdomains to use for the {s} placeholder in the URL template. If this parameter is a single string, each character in the string is a subdomain. If it is an array, each element in the array is a subdomain.
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 WebMercatorTilingScheme 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.
hasAlphaChannel Boolean true optional true if the images provided by this imagery provider include an alpha channel; otherwise, false. 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 potentially reduced.
getFeatureInfoFormats Array.<GetFeatureInfoFormat> optional The formats in which to get feature information at a specific location when UrlTemplateImageryProvider#pickFeatures is invoked. If this parameter is not specified, feature picking is disabled.
enablePickFeatures Boolean true optional 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. Note that this can be dynamically overridden by modifying the UriTemplateImageryProvider#enablePickFeatures property.
Example:
// Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project
var tms = new Cesium.UrlTemplateImageryProvider({
    url : 'https://cesiumjs.org/tilesets/imagery/naturalearthii/{z}/{x}/{reverseY}.jpg',
    credit : '© Analytical Graphics, Inc.',
    tilingScheme : new Cesium.GeographicTilingScheme(),
    maximumLevel : 5
});
// Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme.
var positron = new Cesium.UrlTemplateImageryProvider({
    url : 'http://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png',
    credit : 'Map tiles by CartoDB, under CC BY 3.0. Data by OpenStreetMap, under ODbL.'
});
// Access a Web Map Service (WMS) server.
var wms = new Cesium.UrlTemplateImageryProvider({
   url : 'https://programs.communications.gov.au/geoserver/ows?tiled=true&' +
         'transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
         'styles=&service=WMS&version=1.1.1&request=GetMap&' +
         'layers=public%3AMyBroadband_Availability&srs=EPSG%3A3857&' +
         'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&' +
         'width=256&height=256',
   rectangle : Cesium.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
});
See:

Members

readonlycredit : 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 UrlTemplateImageryProvider#ready returns true.
Default Value: undefined

enablePickFeatures : Boolean

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

readonlyerrorEvent : 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.

readonlyhasAlphaChannel : 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. This function should not be called before ImageryProvider#ready returns true.
Default Value: true

readonlymaximumLevel : Number

Gets the maximum level-of-detail that can be requested, or undefined if there is no limit. This function should not be called before UrlTemplateImageryProvider#ready returns true.
Default Value: undefined

readonlyminimumLevel : Number

Gets the minimum level-of-detail that can be requested. This function should not be called before UrlTemplateImageryProvider#ready returns true.
Default Value: 0

readonlypickFeaturesUrl : String

Gets the URL template to use to use to pick features. If this property is not specified, UrlTemplateImageryProvider#pickFeatures will immediately returned 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.

readonlyproxy : Proxy

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

readonlyready : Boolean

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

readonlyreadyPromise : Promise.<Boolean>

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

readonlyrectangle : Rectangle

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

readonlytileDiscardPolicy : 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 UrlTemplateImageryProvider#ready returns true.
Default Value: undefined

readonlytileHeight : Number

Gets the height of each tile, in pixels. This function should not be called before UrlTemplateImageryProvider#ready returns true.
Default Value: 256

readonlytileWidth : Number

Gets the width of each tile, in pixels. This function should not be called before UrlTemplateImageryProvider#ready returns true.
Default Value: 256

readonlytilingScheme : TilingScheme

Gets the tiling scheme used by this provider. This function should not be called before UrlTemplateImageryProvider#ready returns true.
Default Value: new WebMercatorTilingScheme()

readonlyurl : String

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.

readonlyurlSchemeZeroPadding : Object

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.

Methods

getTileCredits(x, y, level) → Array.<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.

pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined

Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile. This function should not be called before ImageryProvider#ready returns true.
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.

reinitialize(options)

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.

requestImage(x, y, level, request) → Promise.<(Image|Canvas)>|undefined

Requests the image for a given tile. This function should not be called before UrlTemplateImageryProvider#ready returns true.
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. The resolved image may be either an Image or a Canvas DOM object.