WebMapTileServiceImageryProvider

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

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 : '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)
const 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)
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);
Demo:
See:

Members

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

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 562

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.

defaultAlpha : Number|undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 146

The default alpha blending value of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.
Default Value: undefined

defaultBrightness : Number|undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 173

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

defaultContrast : Number|undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 182

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

defaultDayAlpha : Number|undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 164

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

defaultGamma : Number|undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 207

The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.
Default Value: undefined

defaultHue : Number|undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 190

The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
Default Value: undefined

defaultMagnificationFilter : TextureMagnificationFilter
engine/Source/Scene/WebMapTileServiceImageryProvider.js 223

The default texture magnification filter to apply to this provider.
Default Value: undefined

defaultMinificationFilter : TextureMinificationFilter
engine/Source/Scene/WebMapTileServiceImageryProvider.js 215

The default texture minification filter to apply to this provider.
Default Value: undefined

defaultNightAlpha : Number|undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 155

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

defaultSaturation : Number|undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 199

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

dimensions : Object
engine/Source/Scene/WebMapTileServiceImageryProvider.js 616

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

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

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 527

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

readonly hasAlphaChannel : Boolean
engine/Source/Scene/WebMapTileServiceImageryProvider.js 578

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 447

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

readonly minimumLevel : Number
engine/Source/Scene/WebMapTileServiceImageryProvider.js 460

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

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

Gets the proxy used by this provider.

readonly ready : Boolean
engine/Source/Scene/WebMapTileServiceImageryProvider.js 539

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

readonly readyPromise : Promise.<Boolean>
engine/Source/Scene/WebMapTileServiceImageryProvider.js 549

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

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

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

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

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.

readonly tileHeight : Number
engine/Source/Scene/WebMapTileServiceImageryProvider.js 434

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

readonly tileWidth : Number
engine/Source/Scene/WebMapTileServiceImageryProvider.js 421

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

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

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

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

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 396

Gets the URL of the service hosting the imagery.

Methods

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

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) → undefined
engine/Source/Scene/WebMapTileServiceImageryProvider.js 702

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:
Undefined since picking is not supported.

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

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.
Throws:
  • DeveloperError : requestImage must not be called before the imagery provider is ready.

Type Definitions

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

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.
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 `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 <optional>
 256 The tile width in pixels.
tileHeight Number <optional>
 256 The tile height in pixels.
tilingScheme TilingScheme <optional>
 The tiling scheme corresponding to the organization of the tiles in the TileMatrixSet.
rectangle Rectangle <optional>
 Rectangle.MAX_VALUE The rectangle covered by the layer.
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.
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> <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.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets