WebMapTileServiceImageryProvider - Cesium Documentation

new Cesium.WebMapTileServiceImageryProvider(options)

Provides tiled imagery served by WMTS 1.0.0 compliant servers. This provider supports HTTP KVP-encoded and RESTful GetTile requests, but does not yet support the SOAP encoding.

Name Type Description

options

Object

Object with the following properties:

Name	Type	Default	Description
`url`	String		The base URL for the WMTS GetTile operation (for KVP-encoded requests) or the tile-URL template (for RESTful requests). The tile-URL template should contain the following variables: {style}, {TileMatrixSet}, {TileMatrix}, {TileRow}, {TileCol}. The first two are optional if actual values are hardcoded or not required by the server. The {s} keyword may be used to specify subdomains.
`format`	String	`'image/jpeg'`	optional The MIME type for images to retrieve from the server.
`layer`	String		The layer name for WMTS requests.
`style`	String		The style name for WMTS requests.
`tileMatrixSetID`	String		The identifier of the TileMatrixSet to use for WMTS requests.
`tileMatrixLabels`	Array		optional A list of identifiers in the TileMatrix to use for WMTS requests, one per TileMatrix level.
`clock`	Clock		optional A Clock instance that is used when determining the value for the time dimension. Required when options.times is specified.
`times`	TimeIntervalCollection		optional TimeIntervalCollection with its data property being an object containing time dynamic dimension and their values.
`dimensions`	Object		optional A object containing static dimensions and their values.
`tileWidth`	Number	`256`	optional The tile width in pixels.
`tileHeight`	Number	`256`	optional The tile height in pixels.
`tilingScheme`	TilingScheme		optional The tiling scheme corresponding to the organization of the tiles in the TileMatrixSet.
`proxy`	Object		optional A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
`rectangle`	Rectangle	`Rectangle.MAX_VALUE`	optional The rectangle covered by the layer.
`minimumLevel`	Number	`0`	optional The minimum level-of-detail supported by the imagery provider.
`maximumLevel`	Number		optional The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
`ellipsoid`	Ellipsoid		optional The ellipsoid. If not specified, the WGS84 ellipsoid is used.
`credit`	Credit \| String		optional A credit for the data source, which is displayed on the canvas.
`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.

Examples:

// Example 1. USGS shaded relief tiles (KVP)
var shadedRelief1 = new Cesium.WebMapTileServiceImageryProvider({
    url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS',
    layer : 'USGSShadedReliefOnly',
    style : 'default',
    format : 'image/jpeg',
    tileMatrixSetID : 'default028mm',
    // tileMatrixLabels : ['default028mm:0', 'default028mm:1', 'default028mm:2' ...],
    maximumLevel: 19,
    credit : new Cesium.Credit('U. S. Geological Survey')
});
viewer.imageryLayers.addImageryProvider(shadedRelief1);

// Example 2. USGS shaded relief tiles (RESTful)
var shadedRelief2 = new Cesium.WebMapTileServiceImageryProvider({
    url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS/tile/1.0.0/USGSShadedReliefOnly/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.jpg',
    layer : 'USGSShadedReliefOnly',
    style : 'default',
    format : 'image/jpeg',
    tileMatrixSetID : 'default028mm',
    maximumLevel: 19,
    credit : new Cesium.Credit('U. S. Geological Survey')
});
viewer.imageryLayers.addImageryProvider(shadedRelief2);

// Example 3. NASA time dynamic weather data (RESTful)
var times = Cesium.TimeIntervalCollection.fromIso8601({
    iso8601: '2015-07-30/2017-06-16/P1D',
    dataCallback: function dataCallback(interval, index) {
        return {
            Time: Cesium.JulianDate.toIso8601(interval.start)
        };
    }
});
var weather = new Cesium.WebMapTileServiceImageryProvider({
    url : 'https://gibs.earthdata.nasa.gov/wmts/epsg4326/best/AMSR2_Snow_Water_Equivalent/default/{Time}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png',
    layer : 'AMSR2_Snow_Water_Equivalent',
    style : 'default',
    tileMatrixSetID : '2km',
    maximumLevel : 5,
    format : 'image/png',
    clock: clock,
    times: times,
    credit : new Cesium.Credit('NASA Global Imagery Browse Services for EOSDIS')
});
viewer.imageryLayers.addImageryProvider(weather);

Demo:

Cesium Sandcastle Web Map Tile Service with Time Demo

See:

Members

clock : Clock

Gets or sets a clock that is used to get keep the time used for time dynamic parameters.

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 WebMapTileServiceImageryProvider#ready returns true.

dimensions : Object

Gets or sets an object that contains static dimensions and their values.

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.

readonlyformat : String

Gets the mime type of images returned by this imagery provider.

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.

readonlymaximumLevel : Number

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

readonlyminimumLevel : Number

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

readonlyproxy : Proxy

Gets the proxy used by this provider.

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 WebMapTileServiceImageryProvider#ready returns true.

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 WebMapTileServiceImageryProvider#ready returns true.

readonlytileHeight : Number

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

readonlytileWidth : Number

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

readonlytilingScheme : TilingScheme

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

times : TimeIntervalCollection

Gets or sets a time interval collection that is used to get time dynamic parameters. The data of each TimeInterval is an object containing the keys and values of the properties that are used during tile requests.

readonlyurl : String

Gets the URL of the service hosting the imagery.

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

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, request) → Promise.<(Image|Canvas)>|undefined

Requests the image for a given tile. This function should not be called before WebMapTileServiceImageryProvider#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.

Throws:

DeveloperError : requestImage must not be called before the imagery provider is ready.