require(["esri/layers/support/WMTSSublayer"], (WMTSSublayer) => { /* code goes here */ });
import WMTSSublayer from "@arcgis/core/layers/support/WMTSSublayer.js";
esri/layers/support/WMTSSublayer
Represents a sublayer in a WMTSLayer.
Constructors
-
new WMTSSublayer(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
String | Description for the WMTS sublayer. more details | WMTSSublayer | |
Extent | The full extent of the layer. more details | WMTSSublayer | |
String | The unique ID assigned to the sublayer. more details | WMTSSublayer | |
String | The map image format (MIME type) to request. more details | WMTSSublayer | |
String[] | Supported image formats as retrieved from the GetCapabilities request. more details | WMTSSublayer | |
WMTSLayer | The WMTSLayer to which the sublayer belongs. more details | WMTSSublayer | |
WMTSLayer | The parent WMTSLayer to which the sublayer belongs. more details | WMTSSublayer | |
String | The WMTSStyle to request. more details | WMTSSublayer | |
Collection<WMTSStyle> | A collection of supported WMTSStyles as retrieved from the GetCapabilities request. more details | WMTSSublayer | |
TileMatrixSet | The TileMatrixSet to request. more details | WMTSSublayer | |
String | The id of the TileMatrixSet to request. more details | WMTSSublayer | |
Collection<TileMatrixSet> | A collection of supported TileMatrixSets. more details | WMTSSublayer | |
String | The title of the WMTS sublayer used to identify it in places such as the LayerList and Legend widgets. more details | WMTSSublayer |
Property Details
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
description String
-
Description for the WMTS sublayer. This defaults to the value of the Abstract property from the GetCapabilities request.
-
fullExtent Extent
-
The full extent of the layer.
-
id String
-
The unique ID assigned to the sublayer. If not set by the developer, it is automatically generated when the layer is loaded.
-
imageFormat String
-
The map image format (MIME type) to request. Defaults to the first item in imageFormats. Must be one of the supported imageFormats.
-
Supported image formats as retrieved from the GetCapabilities request.
-
parent WMTSLayerSince: ArcGIS Maps SDK for JavaScript 4.27
-
The parent WMTSLayer to which the sublayer belongs.
-
styleId String
-
The WMTSStyle to request. Defaults to the id of the first item in styles. Should be one of the supported styles.
-
styles Collection<WMTSStyle>
-
A collection of supported WMTSStyles as retrieved from the GetCapabilities request.
-
tileMatrixSet TileMatrixSet
-
The TileMatrixSet to request. Defaults to the first item in tileMatrixSets that matches the spatialReference of the view. Must be one of the supported tileMatrixSets.
-
tileMatrixSetId String
-
The id of the TileMatrixSet to request. Defaults to the id of the first item in tileMatrixSets that matches the spatialReference of the view. Must be one of the supported tileMatrixSets.
-
tileMatrixSets Collection<TileMatrixSet>
-
A collection of supported TileMatrixSets.
-
title String
-
The title of the WMTS sublayer used to identify it in places such as the LayerList and Legend widgets. This defaults to the value of the Title property from the WMTS GetCapabilities request.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
WMTSSublayer | Creates a deep clone of the WMTS sublayer. more details | WMTSSublayer | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | WMTSSublayer | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | WMTSSublayer |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
clone(){WMTSSublayer}
-
Creates a deep clone of the WMTS sublayer.
ReturnsType Description WMTSSublayer A deep clone of the WMTS sublayer instance that invoked this method.
-
fromJSON(json){*}static
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
json
parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.