WebMapTileServiceImageryProvider

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.

// Example 1. USGS shaded relief tiles (KVP)
const shadedRelief1 = new 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 Credit('U. S. Geological Survey')
});
viewer.imageryLayers.addImageryProvider(shadedRelief1);
// Example 2. USGS shaded relief tiles (RESTful)
const shadedRelief2 = new 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 Credit('U. S. Geological Survey')
});
viewer.imageryLayers.addImageryProvider(shadedRelief2);
// Example 3: NASA time dynamic snowpack data (RESTful)
// Define time intervals for the layer based on the capabilities XML
const times = TimeIntervalCollection.fromIso8601({
iso8601: '2025-01-01/2025-09-01/P5D', // Use the valid interval(s) from the Dimension section
dataCallback: function(interval, index) {
// Return an object with the Time variable used in the URL template
return {
Time: JulianDate.toIso8601(interval.start, 0)
};
}
});
// Get the internal clock, set desired start, stop, and multiplier
const clock = viewer.clock;
clock.startTime = JulianDate.fromIso8601('2025-01-01');
clock.currentTime = JulianDate.fromIso8601('2025-01-01');
clock.stopTime = JulianDate.fromIso8601('2025-09-01');
clock.clockRange = ClockRange.LOOP_STOP;
clock.multiplier = 1; // 1 day per second
clock.clockStep = ClockStep.SYSTEM_CLOCK_MULTIPLIER;

viewer.timeline.zoomTo(clock.startTime, clock.stopTime);

const weather = new WebMapTileServiceImageryProvider({
url: 'https://gibs.earthdata.nasa.gov/wmts/epsg3857/best/AMSRU2_Snow_Water_Equivalent_5Day/default/{Time}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png',
layer: 'AMSRU2_Snow_Water_Equivalent_5Day',
style: 'default',
tileMatrixSetID: 'GoogleMapsCompatible_Level6',
format: 'image/png',
clock: clock,
times: times,
credit: new 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 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);

See also

Constructors

Types

Link copied to clipboard
object Companion
Link copied to clipboard

Initialization options for the WebMapTileServiceImageryProvider constructor

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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 {@link WebMapTileServiceImageryProvider.ConstructorOptions#getFeatureInfoUrl} is specified, and false otherwise.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Gets the getFeatureInfo URL of the WMTS server.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets the proxy used by this provider.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Gets the height of each tile, in pixels.

Link copied to clipboard

Gets the width of each tile, in pixels.

Link copied to clipboard

Gets the tiling scheme used by this provider.

Link copied to clipboard

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.

Link copied to clipboard
val url: String

Gets the URL of the service hosting the imagery.

Functions

Link copied to clipboard

Gets the credits to be displayed when a given tile is displayed.

Link copied to clipboard
suspend fun pickFeatures(x: Double, y: Double, level: Int, longitude: Double, latitude: Double): ReadonlyArray<ImageryLayerFeatureInfo>?

Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile.

Link copied to clipboard
Link copied to clipboard
suspend fun requestImage(x: Double, y: Double, level: Int, request: Request? = definedExternally): ImageryTypes?

Requests the image for a given tile.

Link copied to clipboard
fun requestImageAsync(x: Double, y: Double, level: Int, request: Request? = definedExternally): Promise<ImageryTypes>?