WebMapTileServiceImageryProvider

new Cesium.WebMapTileServiceImageryProvider(options)
engine/Source/Scene/WebMapTileServiceImageryProvider.js 167

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 WebMapTileServiceImageryProvider.ConstructorOptions Object describing initialization options
Examples:
// Example 1. USGS shaded relief tiles (KVP)
const shadedRelief1 = new Cesium.WebMapTileServiceImageryProvider({
    url : 'https://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)
const shadedRelief2 = new Cesium.WebMapTileServiceImageryProvider({
    url : 'https://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)
const times = Cesium.TimeIntervalCollection.fromIso8601({
    iso8601: '2015-07-30/2017-06-16/P1D',
    dataCallback: function dataCallback(interval, index) {
        return {
            Time: Cesium.JulianDate.toIso8601(interval.start)
        };
    }
});
const 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);
// Example 4. Digital Earth AfricA waterbodies with GetFeatureInfo support (RESTful)
const waterbodies = new Cesium.WebMapTileServiceImageryProvider({
   url: "https://geoserver.digitalearth.africa/geoserver/gwc/service/wmts/rest/{layer}/{style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}?format={format}",
   layer: "waterbodies:DEAfrica_Waterbodies",
   style: "waterbodies:waterbodies_v0_0_4",
   tileMatrixSetID: "EPSG:3857",
   tileMatrixLabels: [
     "EPSG:3857:0",
     "EPSG:3857:1",
     "EPSG:3857:2",
     "EPSG:3857:3",
     "EPSG:3857:4",
     "EPSG:3857:5",
     "EPSG:3857:6",
     "EPSG:3857:7",
     "EPSG:3857:8",
     "EPSG:3857:9",
     "EPSG:3857:10",
     "EPSG:3857:11",
     "EPSG:3857:12",
     "EPSG:3857:13",
     "EPSG:3857:14",
     "EPSG:3857:15",
     "EPSG:3857:16",
     "EPSG:3857:17",
     "EPSG:3857:18",
     "EPSG:3857:19",
     "EPSG:3857:20",
     "EPSG:3857:21",
     "EPSG:3857:22",
     "EPSG:3857:23",
     "EPSG:3857:24",
     "EPSG:3857:25",
     "EPSG:3857:26",
     "EPSG:3857:27",
     "EPSG:3857:28",
     "EPSG:3857:29",
     "EPSG:3857:30",
   ],
   format: "image/png",
   enablePickFeatures: true,
   getFeatureInfoUrl: "https://geoserver.digitalearth.africa/geoserver/gwc/service/wmts/rest/{layer}/{style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}/{j}/{i}?format={format}",
});

viewer.imageryLayers.addImageryProvider(waterbodies);
Demo:
See:

Members

static constant Cesium.WebMapTileServiceImageryProvider.DefaultParameters : object
engine/Source/Scene/WebMapTileServiceImageryProvider.js 696

The default parameters to include in the WMTS URL to obtain images. The values are as follows: service=WMTS version=1.0.0 request=GetTile

static constant Cesium.WebMapTileServiceImageryProvider.GetFeatureInfoDefaultParameters : object
engine/Source/Scene/WebMapTileServiceImageryProvider.js 711

The default parameters to include in the WMTS URL to get feature information. The values are as follows: service=WMTS version=1.0.0 request=GetFeatureInfo

clock : Clock
engine/Source/Scene/WebMapTileServiceImageryProvider.js 549

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

readonly credit : Credit
engine/Source/Scene/WebMapTileServiceImageryProvider.js 502

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.

dimensions : object
engine/Source/Scene/WebMapTileServiceImageryProvider.js 577

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

enablePickFeatures : boolean
engine/Source/Scene/WebMapTileServiceImageryProvider.js 535

Gets or sets a value indicating whether feature picking is enabled. If true, WebMapTileServiceImageryProvider#pickFeatures will invoke the GetFeatureInfo service on the WMTS server and attempt to interpret the features included in the response. If false, WebMapTileServiceImageryProvider#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. Defaults to true for KVP encoding. For RESTful encoding, defaults to true only when WebMapTileServiceImageryProvider.ConstructorOptions#getFeatureInfoUrl is specified, and false otherwise.

readonly errorEvent : Event
engine/Source/Scene/WebMapTileServiceImageryProvider.js 477

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.

readonly format : string
engine/Source/Scene/WebMapTileServiceImageryProvider.js 489

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

readonly getFeatureInfoUrl : Resource|string
engine/Source/Scene/WebMapTileServiceImageryProvider.js 597

Gets the getFeatureInfo URL of the WMTS server.

readonly hasAlphaChannel : boolean
engine/Source/Scene/WebMapTileServiceImageryProvider.js 518

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.

readonly maximumLevel : number|undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 413

Gets the maximum level-of-detail that can be requested.

readonly minimumLevel : number
engine/Source/Scene/WebMapTileServiceImageryProvider.js 425

Gets the minimum level-of-detail that can be requested.

readonly proxy : Proxy
engine/Source/Scene/WebMapTileServiceImageryProvider.js 377

Gets the proxy used by this provider.

readonly rectangle : Rectangle
engine/Source/Scene/WebMapTileServiceImageryProvider.js 449

Gets the rectangle, in radians, of the imagery provided by this instance.

readonly tileDiscardPolicy : TileDiscardPolicy
engine/Source/Scene/WebMapTileServiceImageryProvider.js 463

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.

readonly tileHeight : number
engine/Source/Scene/WebMapTileServiceImageryProvider.js 401

Gets the height of each tile, in pixels.

readonly tileWidth : number
engine/Source/Scene/WebMapTileServiceImageryProvider.js 389

Gets the width of each tile, in pixels.

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

Gets the tiling scheme used by this provider.

times : TimeIntervalCollection
engine/Source/Scene/WebMapTileServiceImageryProvider.js 564

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.

readonly url : string
engine/Source/Scene/WebMapTileServiceImageryProvider.js 365

Gets the URL of the service hosting the imagery.

Methods

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

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.

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

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.

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

Requests the image for a given tile.
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.

Type Definitions

Cesium.WebMapTileServiceImageryProvider.ConstructorOptions
engine/Source/Scene/WebMapTileServiceImageryProvider.js 12

Initialization options for the WebMapTileServiceImageryProvider constructor
Properties:
Name Type Attributes Default Description
url Resource | 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 <optional>
 'image/jpeg' 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.
enablePickFeatures boolean <optional>
 If true, WebMapTileServiceImageryProvider#pickFeatures will invoke the GetFeatureInfo operation on the WMTS server and return the features included in the response. If false, WebMapTileServiceImageryProvider#pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you know your WMTS server does not support GetFeatureInfo or if you don't want this provider's features to be pickable. Defaults to true for KVP encoding. For RESTful encoding, defaults to true only when WebMapTileServiceImageryProvider.ConstructorOptions#getFeatureInfoUrl is specified, and false otherwise.
getFeatureInfoParameters object <optional>
 Additional parameters to include in GetFeatureInfo requests. Keys are lowercased internally.
getFeatureInfoUrl Resource | string <optional>
 The GetFeatureInfo URL of the WMTS service. If not specified, the value of url is used.
getFeatureInfoFormats Array.<GetFeatureInfoFormat> <optional>
 WebMapTileServiceImageryProvider.DefaultGetFeatureInfoFormats The formats in which to try WMTS GetFeatureInfo requests.
rectangle Rectangle <optional>
 Rectangle.MAX_VALUE The rectangle covered by the layer.
tilingScheme TilingScheme <optional>
 The tiling scheme corresponding to the organization of the tiles in the TileMatrixSet.
ellipsoid Ellipsoid <optional>
 The ellipsoid. If not specified, the WGS84 ellipsoid is used.
tileWidth number <optional>
 256 The tile width in pixels.
tileHeight number <optional>
 256 The tile height in pixels.
minimumLevel number <optional>
 0 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.
tileMatrixLabels Array <optional>
 A list of identifiers in the TileMatrix to use for WMTS requests, one per TileMatrix level.
credit Credit | string <optional>
 A credit for the data source, which is displayed on the canvas.
subdomains string | Array.<string> <optional>
 'abc' 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.
clock Clock <optional>
 A Clock instance that is used when determining the value for the time dimension. Required when `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.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets