require(["esri/layers/WMTSLayer"], function(WMTSLayer) { /* code goes here */ });
Class: esri/layers/WMTSLayer
Inheritance: WMTSLayer Layer Accessor
Since: ArcGIS API for JavaScript 4.4

The WMTSLayer is used to create layers based on OGC Web Map Services (WMTS). The WMTSLayer initially executes a WMTS GetCapabilities request, which might require CORS or a proxy page.

See also:

Constructors

new WMTSLayer(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:
// Typical usage
WMTSLayer = new WMTSLayer({
  url: "https://gibs.earthdata.nasa.gov/wmts/epsg4326/best", // url to the service
  activeLayer: {
    id: "SRTM_Color_Index",
  }
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummary
WMTSSublayer

Currently active sublayer.

more details
more details
String

Copyright information for the WMTS service.

more details
more details
Object

Use this to append different custom parameters to the WMTS tile requests.

more details
more details
Object

Use this to append custom parameters to all WMTS requests.

more details
more details
String

The name of the class.

more details
more details
Extent

The full extent of the layer.

more details
more details
String

The unique ID assigned to the layer.

more details
more details
String

Indicates how the layer should display in the LayerList widget.

more details
more details
Boolean

Indicates whether the layer's resources have loaded.

more details
more details
Error

The Error object returned if an error occurred while loading.

more details
more details
String

Represents the status of a load operation.

more details
more details
Object[]

A list of warnings which occurred while loading.

more details
more details
Number

The opacity of the layer.

more details
more details
PortalItem

The portal item from which the layer is loaded.

more details
more details
String

The service mode for the WMTS layer.

more details
more details
Collection

A collection of WMTSSublayer objects.

more details
more details
String

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

more details
more details
String

For WMTSLayer the type is wmts.

more details
more details
String

The URL of the WMTS service.

more details
more details
String

Version of the WMTS specification to use.

more details
more details
Boolean

Indicates if the layer is visible in the View.

more details
more details

Property Details

activeLayerWMTSSublayer

Currently active sublayer. Defaults to the first sublayer in sublayers.

Copyright information for the WMTS service. This defaults to the value of the AccessConstraints property from the GetCapabilities request.

customLayerParametersObject

Use this to append different custom parameters to the WMTS tile requests. The custom layer parameters are applied to GetTile.

customParametersObject

Use this to append custom parameters to all WMTS requests. The custom parameters are applied to GetCapabilities and GetTile. For example, if an access key is required, the key can be configured as a custom parameter.

declaredClassStringreadonly

The name of the class. The declared class name is formatted as esri.folder.className.

fullExtentExtent autocast

The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.

Example:
// Once the layer loads, set the view's extent to the layer's fullextent
layer.then(function(){
  view.extent = layer.fullExtent;
});

The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.

listModeString

Indicates how the layer should display in the LayerList widget. The known values are listed below.

ValueDescription
showThe layer is visible in the table of contents.
hideThe layer is hidden in the table of contents.
hide-childrenIf the layer is a GroupLayer, hide the children layers from the table of contents.
Default Value: show

loadedBooleanreadonly

Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.

Default Value: false

loadErrorErrorreadonly

The Error object returned if an error occurred while loading.

Default Value: null

loadStatusStringreadonly

Represents the status of a load operation.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe object's resources failed to load. See loadError for more details.
Default Value: not-loaded

loadWarningsObject[]readonly

A list of warnings which occurred while loading.

opacityNumber

The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Default Value: 1
Example:
// Makes the layer 50% transparent
layer.opacity = 0.5;

portalItemPortalItem

The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to to load with the layerId property.

Examples:
// while this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // the first layer in the service is returned
});
// set hostname when using an on-premise portal (default is Arcgis Online)
// esriConfig.portalUrl = "http://myHostName.esri.com/arcgis";

// while this example uses FeatureLayer, this same pattern can be
// used for SceneLayers
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

serviceModeString

The service mode for the WMTS layer. If not specified, the API will first make a getCapabilities request using RESTful. If that fails, it will try using KVP.

Possible Values: RESTful | KVP

Default Value: RESTful

sublayersCollection

A collection of WMTSSublayer objects.

titleString

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

typeStringreadonly

For WMTSLayer the type is wmts.

The URL of the WMTS service. The URL for the GetCapabilities is created based on the url and serviceMode properties. For example https://gibs.earthdata.nasa.gov/wmts/epsg4326/best.

versionString

Version of the WMTS specification to use. Probably 1.0.0.

visibleBoolean

Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.

Default Value: true
Example:
// The layer is no longer visible in the view
layer.visible = false;

Method Overview

NameReturn TypeSummary
Promise

An instance of this class is a Promise.

more details
more details

Cancels a load() operation if it is already in progress.

more details
more details
WMTSSublayer

Returns a WMTSSublayer based on the given sublayer id.

more details
more details
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more details
Boolean

An instance of this class is a Promise.

more details
more details
Boolean

An instance of this class is a Promise.

more details
more details
Boolean

An instance of this class is a Promise.

more details
more details
Promise

Loads the resources referenced by this class.

more details
more details
Object

Registers an event handler on the instance.

more details
more details
Promise

An instance of this class is a Promise.

more details
more details
Promise

An instance of this class is a Promise.

more details
more details

Method Details

always(callbackOrErrback){Promise}inherited

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:
callbackOrErrback Function
optional

The function to execute when the promise is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
Example:
// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

cancelLoad()inherited

Cancels a load() operation if it is already in progress.

findSublayerById(id){WMTSSublayer}

Returns a WMTSSublayer based on the given sublayer id.

Parameter:

The id of the WMTS sublayer.

Returns:
TypeDescription
WMTSSublayerReturns the requested WMTSSublayer.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.

isFulfilled(){Boolean}inherited

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been rejected.

isResolved(){Boolean}inherited

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been resolved.

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

Returns:
TypeDescription
PromiseResolves when the resources have loaded.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

otherwise(errback){Promise}inherited

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:
errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
Example:
// Although this example uses MapView, any class instance that is a promise may use otherwise() in the same way
var view = new MapView();
view.otherwise(function(error){
  // This function will execute if the promise is rejected due to an error
});

then(callback, errback, progback){Promise}inherited

An instance of this class is a Promise. Therefore then() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

progback Function
optional

The function to invoke when the promise emits a progress update.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var view = new MapView();
view.then(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Event Overview

NameTypeSummary
{view: View,layerView: LayerView}

Fires after the layer's LayerView is created and rendered in a view.

more details
more details
{view: View,layerView: LayerView}

Fires after the layer's LayerView is destroyed and no longer renders in a view.

more details
more details

Event Details

layerview-createinherited

Fires after the layer's LayerView is created and rendered in a view.

Properties:
view View

The view in which the layerView was created.

layerView LayerView

The LayerView rendered in the view representing the layer in layer.

See also:
Example:
// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});

layerview-destroyinherited

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Properties:
view View

The view in which the layerView was destroyed.

layerView LayerView

The destroyed LayerView representing the layer.

API Reference search results

NameTypeModule

There were no match results from your search criteria.