Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: WMTSLayer
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/WMTSLayer"], function(WMTSLayer) { /* code goes here */ });
Description
(Added at v2.4)
The WMTSLayer class is used to create a layer based on an OGC Web Map Tile Service layer.Samples
Search for samples that use this class.Class hierarchy
esri/layers/Layer |_esri/layers/TiledMapServiceLayer |_esri/layers/WMTSLayer
Constructors
| Name | Summary |
|---|---|
| new WMTSLayer(url, options?) | Creates a new WMTSLayer object. |
Properties
| Name | Type | Summary |
|---|---|---|
| className | String | class attribute of the layer's node. |
| copyright | String | Copyright information for the service. |
| customLayerParameters | Object | Use this to append different custom parameters to a WMTS tile request. |
| customParameters | Object | Use this to append custom parameters to all WMTS requests. |
| description | String | The description of the active layer if specified in the capabilties file or the resource info. |
| format | String | The tile format. |
| fullExtent | Extent | The full extent of the active layer. |
| id | String | ID assigned to the layer. |
| initialExtent | Extent | The initial extent of the active layer. |
| layerInfos | Object[] | An array of WMTSLayerInfo objects. |
| loadError | Error | Set if the layer failed to load. |
| loaded | Boolean | When the layer is loaded, the value becomes "true", and layer properties can be accessed. |
| maxScale | Number | Maximum visible scale for the layer. |
| minScale | Number | Minimum visible scale for the layer. |
| opacity | Number | Opacity or transparency of layer. |
| refreshInterval | Number | Refresh interval of the layer in minutes. |
| serviceMode | String | The service mode for the WMTS layer. |
| showAttribution | Boolean | When true, the layer's attribution is displayed on the map. |
| spatialReference | SpatialReference | The spatial reference for the WMTS service. |
| suspended | Boolean | When true, the layer is suspended. |
| tileInfo | TileInfo | The tile info for the active layer. |
| title | String | Title of the WMTS service. |
| url | String | URL to the ArcGIS Server REST resource that represents a map service. |
| version | String | Version of the WMTS service. |
| visible | Boolean | Visibility of the layer. |
| visibleAtMapScale | Boolean | When true, the layer is visible at the current map scale. |
Methods
| Name | Return type | Summary |
|---|---|---|
| attr(name, value) | Layer | Adds a new attribute or changes the value of an existing attribute on the layer's node. |
| getMap() | Map | Returns reference to the map control the layer is added to. |
| getNode() | HTMLElement | Returns the layer's DOM node. |
| getTileUrl(level, row, column) | String | Method to implement when extending TiledMapServiceLayer. |
| hide() | None | Sets the visibility of the layer to "false". |
| isVisibleAtScale(scale) | Boolean | Returns true if the layer is visible at the given scale. |
| refresh() | None | Reloads all the tiles in the current view. |
| resume() | None | Resumes layer drawing. |
| setActiveLayer(WMTSLayerInfo) | None | Set the active layer for the WMTS service. |
| setCustomParameters(customParameters, customLayerParameters?) | None | Sets the custom parameters used on the WMTS layer. |
| setExclusionAreas() | Array | Specify areas to not show tiles. |
| setMaxScale(scale) | None | Set the maximum scale for the layer. |
| setMinScale(scale) | None | Set the minimum scale for the layer. |
| setOpacity(opacity) | None | Sets the opacity of the layer. |
| setRefreshInterval(interval) | Layer | Changes the layer's refresh interval to the given value (in minutes). |
| setScaleRange(minScale, maxScale) | None | Set the scale range for the layer. |
| setVisibility(isVisible) | None | Sets the visibility of the layer. |
| show() | None | Sets the visibility of the layer to "true". |
| suspend() | None | Suspends layer drawing. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| error | {
error: < | Fires when there is a problem retrieving a layer. |
| load | {
layer: < | Fires after layer properties for the layer are successfully populated. |
| opacity-change | {
opacity: < | Fires when the layer opacity has been changed, and returns an object with the opacity value. |
| refresh-interval-change | This event is fired when the layer's refreshInterval is modified. | |
| resume | Fires when a layer resumes drawing. | |
| scale-range-change | Fires when a layer's minScale and/or maxScale is changed. | |
| scale-visibility-change | Fires when a layer's scale visibility changes. | |
| suspend | Fires when a layer suspends drawing. | |
| update | Fires any time a layer has finished loading or updating itself. | |
| update-end | {
error: < | Fires when a layer has finished updating its content. |
| update-start | Fires when a layer begins to update its content. | |
| visibility-change | {
visible: < | Fires when the layer visibility has been changed, and returns an object with a Boolean visible property containing the new visibility value of the layer. |
Constructor Details
Creates a new WMTSLayer object.
Parameters:
< |
Required | URL for the WMTS endpoint. |
< |
Optional | Optional parameters. See options list. |
options properties: < |
Optional | The customLayerParameters object used for the WMTS Layer. NOTE: If this is also set within the constructor's resourceInfo, the parameters within the resourceInfo take precedence. |
||||||||
< |
Optional | The customParameters object used for the WMTS Layer. NOTE: If this is also set within the constructor's resourceInfo, the parameters within the resourceInfo take precedence. |
||||||||
< |
Optional | A WMTSLayerInfo object that when ResourceInfo options are not specified the map will display the first layer in the WMTS capabilities that matches the properties specified by WMTSLayerInfo. For example, if the WMTSLayerInfo specifies an identifier but does not specify a tileMatrixSet the first layer in the service that has the same id will be used. | ||||||||
< |
Optional | An optional resource info object. The default behavior of a WMTSLayer is to execute a WMTS GetCapabilities request. If resourceInfo is specified a GetCapabilities request is not executed. The resourceInfo object has the following parameters:
var resourceInfo = {
version: "1.0.0",
layerInfos: [layerInfo1, layerInfo2],
copyright: "open layer"
};
|
||||||||
< |
Optional | Specify the service type. Valid values are "KVP" or "RESTful". If the specified mode does not match the service the WMTS layer will not be created. The default value is "RESTful". |
Object Specifications:
<
resourceInfo>< |
Required | Use this to append different custom parameters to a WMTS tile request.
"customLayerParameters" : {
"QUALITY": "90"
}
The custom parameters are applied to
GetTileNOTE: customLayerParameters can be part of resourceInfo or outside of it in the WMTSLayer's constructor. If it is set in resourceInfo and also directly as customLayerParameters in the constructor, the one in resourceInfo takes precedence. |
< |
Required | Use this to append custom parameters to all WMTS requests. If an access key is required, the key can be configured as a custom parameter.
"customParameters" : {"key": "1R-ADNF-6NCD"}
The custom parameters are applied to
GetCapabilities and GetTileNOTE: customParameters can be part of resourceInfo or outside of it in the WMTSLayer's constructor. If it is set in resourceInfo and also directly as customParameters in the constructor, the one in resourceInfo takes precedence. |
Sample:
require([
"esri/layers/WMTSLayerInfo", "esri/layers/WMTSLayer", ...
], function(WMTSLayerInfo, WMTSLayer, ... ) {
var layerInfo = new WMTSLayerInfo({
identifier: "world",
tileMatrixSet: "EPSG:4326",
format: "gif"
});
var options = {
serviceMode: "KVP",
layerInfo: layerInfo
};
var wmtsLayer = new WMTSLayer("http://v2.suite.opengeo.org/geoserver/gwc/service/wmts", options);
...
});
Property Details
<String
StringCopyright information for the service. This information is only available if specified in the capabilities file or the resource info object.
<Object
ObjectUse this to append different custom parameters to a WMTS tile request. The custom parameters are applied to
NOTE:
GetTile.
NOTE:
customLayerParameters can be part of resourceInfo or outside of it in the WMTSLayer's constructor. If both are set in resourceInfo and also directly as customLayerParameters in the constructor, the one in resourceInfo takes precedence. (Added at v3.18)Sample:
"customLayerParameters" : {
"QUALITY": "90"
}
<Object
ObjectUse this to append custom parameters to all WMTS requests. If an access key is required, the key can be configured as a custom parameter.
The custom parameters are applied to
NOTE:
GetCapabilities and GetTile.
NOTE:
customParameters can be part of resourceInfo or outside of it in the WMTSLayer's constructor. If it is set in resourceInfo and also directly as customParameters in the constructor, the one in resourceInfo takes precedence. (Added at v3.18)Sample:
"customParameters" : {"key": "1R-ADNF-6NCD"}
<String
StringThe description of the active layer if specified in the capabilties file or the resource info.
<String
StringThe tile format.
<Extent
ExtentThe full extent of the active layer.
<String
StringID assigned to the layer. If not assigned, esri.Map assigns value. By default, the ID of the layer is "layer" followed by a number. The ID can be user defined only in the layer constructor.
Sample:
- Setting the layer ID in the layer constructor.
require([ "esri/layers/ArcGISDynamicMapServiceLayer", ... ], function(ArcGISDynamicMapServiceLayer, ... ) { var population = new ArcGISDynamicMapServiceLayer("http://myserver/arcgis/rest/population/MapServer/Layers", {id:"population"}); ... }); - Setting the layer ID after a layer is initialized.
population.id = "population";
- Retrieving the layer ID.
function getMapLayers() { for (var j=0, jl=map.layerIds.length; j<jl; j++) { var currentLayer = map.getLayer(map.layerIds[j]); alert("id: " + currentLayer.id); } }
<Extent
ExtentThe initial extent of the active layer.
<Object[]
Object[]An array of WMTSLayerInfo objects.
<Error
ErrorSet if the layer failed to load. (Added at v3.9)
<Boolean
BooleanWhen the layer is loaded, the value becomes "true", and layer properties can be accessed. The onLoad event is also fired.
Known values:
true | false<Number
NumberMaximum visible scale for the layer. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. (Added at v3.1)
Default value:
0<Number
NumberMinimum visible scale for the layer. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a visible scale. (Added at v3.1)
Default value:
0<Number
NumberOpacity or transparency of layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.
Known values:
0.0 - 1.0Default value:
1.0<Number
NumberRefresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled. (Added at v3.7)
<Boolean
BooleanWhen true, the layer's attribution is displayed on the map. (Added at v3.1)
Known values:
true | falseDefault value:
true<SpatialReference
SpatialReferenceThe spatial reference for the WMTS service.
<Boolean
BooleanWhen true, the layer is suspended. A layer is considered to be suspended when one of the following is true:
- The layer is hidden.
- The layer is not visible at the current map scale.
- The layer is explicitly suspended by calling the
Layer.suspendmethod.
Known values:
true | false<TileInfo
TileInfoThe tile info for the active layer.
<String
StringTitle of the WMTS service.
<String
StringURL to the ArcGIS Server REST resource that represents a map service. To obtain the URL, use Services Directory. An example URL for the Street Map service on ArcGIS Online is:
https://server.arcgisonline.com/arcgis/rest/services/World_Imagery/MapServer. (Added at v1.2)
https://server.arcgisonline.com/arcgis/rest/services/World_Imagery/MapServer. (Added at v1.2)
<String
StringVersion of the WMTS service.
<Boolean
BooleanWhen true, the layer is visible at the current map scale. (Added at v3.1)
Known values:
true | falseMethod Details
Adds a new attribute or changes the value of an existing attribute on the layer's node. Removes the attribute if the value is
null or undefined. (Added at v3.7)Return type:
LayerReturns reference to the map control the layer is added to. Returns
null or undefined if it is not added to a map. (Added at v3.7)Return type:
MapMethod to implement when extending TiledMapServiceLayer. For more details, see Creating custom layer types. (Added at v1.3)
Return type:
StringSets the visibility of the layer to "false". The layer is not removed, but it is hidden from view.
Returns true if the layer is visible at the given scale. (Added at v3.1)
Return type:
BooleanParameters:
< |
Required | The scale at which to check if the layer is visible. |
Set the active layer for the WMTS service. The layer must be in the same spatial reference as the current active layer.
Parameters:
< |
Required | The WMTSLayerInfo for the layer to make active. |
Sample:
require([
"esri/layers/WMTSLayerInfo", ...
], function(WMTSLayerInfo, ... ) {
var layerInfo = new WMTSLayerInfo({identifier: layerId});
wmtsLayer.setActiveLayer(layerInfo);
...
});
Sets the custom parameters used on the WMTS layer. If customParameters is used, it applies on the
NOTE: This will update the properties and refresh the layer. In addition, if one of the inputs is empty it will overwrite it as not being set. (Added at v3.18)
GetCapabilities and GetTile methods, whereas customLayerParameters is used only for map requests. If both are set, customLayerParameters takes precedence.
NOTE: This will update the properties and refresh the layer. In addition, if one of the inputs is empty it will overwrite it as not being set. (Added at v3.18)
Parameters:
< |
Required | The customParameters object used append WMTS requests. |
< |
Optional | The customLayerParameters object used append specific WMTS layer requests. |
Specify areas to not show tiles. See the exclusionAreas constructor option description for specifics as to how exclusionAreas work. (Added at v3.10)
Return type:
ArraySample:
var exclusionAreas = [{
minScale: 40000,
maxScale: 9028,
geometry: new Extent(
13871520.850500003,
3910293.086000003,
14574034.873400003,
4686306.161399998,
new SpatialReference(102100)
)
}];Set the maximum scale for the layer. (Added at v3.1)
Parameters:
< |
Required | The maximum scale at which the layer is visible. |
Set the minimum scale for the layer. (Added at v3.1)
Parameters:
< |
Required | The minimum scale at which the layer is visible. |
Sets the opacity of the layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.
Parameters:
< |
Required | Value from 0 to 1, where 0 is 100% transparent and 1 has no transparency. The default value is 1. |
Sample:
layer.setOpacity(0.5);
Changes the layer's refresh interval to the given value (in minutes). Non-zero value sets up automatic layer refresh at the specified interval. Value of 0 stops auto refresh. (Added at v3.7)
Return type:
LayerParameters:
< |
Required | Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled. |
Set the scale range for the layer. If
minScale and maxScale are set to 0 then the layer will be visible at all scales. (Added at v3.1)Sets the visibility of the layer. When true, the layer is visible.
Parameters:
< |
Required | Set the visibility of the layer. |
Event Details
[ On Style Events | Connect Style Event ]
Fires when there is a problem retrieving a layer. Should be used in favor of onError. (Added at v3.5)
Event Object Properties:
< |
ArcGIS Server error message returned in a JavaScript error object. |
Fires after layer properties for the layer are successfully populated. This event must be successful before the layer can be added to the map. Should be used in favor of onLoad. (Added at v3.5)
Event Object Properties:
< |
The loaded layer. |
Fires when the layer opacity has been changed, and returns an object with the opacity value. Should be used in favor of onOpacityChange. (Added at v3.5)
Event Object Properties:
< |
Fires when the layer opacity (transparency) changes. A number property named opacity that indicates the new opacity. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency. |
This event is fired when the layer's
refreshInterval is modified. (Added at v3.7)Fires when a layer's minScale and/or maxScale is changed. Should be used in favor of onScaleRangeChange. (Added at v3.5)
Fires when a layer's scale visibility changes. The scale visibility changes when a layer is initially visible and becomes invisible because the map scale does not intersect the layer's scale range or vice versa. Should be used in favor of onScaleVisibilityChange. (Added at v3.5)
Fires any time a layer has finished loading or updating itself.
For an ArcGISTiledMapServiceLayer,
the event fires when all required tiles have been retrieved and displayed. For an
ArcGISDynamicMapServiceLayer or
ArcGISImageServiceLayer, the event fires
when the map image has been retrieved and displayed. For a GraphicsLayer,
the event fires when all graphics have been redrawn after a pan or zoom.
Deprecated at v2.0. Use update-start and update-end instead. (Added at v3.6)
Fires when a layer has finished updating its content. It is the responsibility of the subclass to determine when this event is fired. Should be used in favor of onUpdateEnd. (Added at v3.5)
Event Object Properties:
< |
Optional argument. The error object is available when an error occurs during the update. |
Fires when a layer begins to update its content. It is the responsibility of the subclass to determine when this event is fired. Should be used in favor of onUpdateStart. (Added at v3.5)
Fires when the layer visibility has been changed, and returns an object with a Boolean visible property containing the new visibility value of the layer. Should be used in favor of onVisibilityChange. (Added at v3.5)
Event Object Properties:
< |
Fires when the layer visibility changes. A boolean property named visible indicates whether or not the layer is visible after visibility changed. |