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
-
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 |
---|---|---|---|
The name of the class. | Accessor | ||
Description for the WMTS sublayer. | WMTSSublayer | ||
The full extent of the layer. | WMTSSublayer | ||
The unique ID assigned to the sublayer. | WMTSSublayer | ||
The map image format (MIME type) to request. | WMTSSublayer | ||
Supported image formats as retrieved from the GetCapabilities request. | WMTSSublayer | ||
The WMTSLayer to which the sublayer belongs. | WMTSSublayer | ||
The parent WMTSLayer to which the sublayer belongs. | WMTSSublayer | ||
The WMTSStyle to request. | WMTSSublayer | ||
A collection of supported WMTSStyles as retrieved from the GetCapabilities request. | WMTSSublayer | ||
The TileMatrixSet to request. | WMTSSublayer | ||
The id of the TileMatrixSet to request. | WMTSSublayer | ||
A collection of supported TileMatrixSets. | WMTSSublayer | ||
The title of the WMTS sublayer used to identify it in places such as the LayerList and Legend widgets. | WMTSSublayer |
Property Details
-
description
description String
-
Description for the WMTS sublayer. This defaults to the value of the Abstract property from the GetCapabilities request.
-
fullExtent
fullExtent Extent
-
The full extent of the layer.
-
id
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
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.
-
styles
styles Collection<WMTSStyle>
-
A collection of supported WMTSStyles as retrieved from the GetCapabilities request.
-
tileMatrixSet
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
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
tileMatrixSets Collection<TileMatrixSet>
-
A collection of supported TileMatrixSets.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of the WMTS sublayer. | WMTSSublayer | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | WMTSSublayer | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | WMTSSublayer |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 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
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.
-
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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 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
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.