ESM: import WMTSSublayer from "@arcgis/core/layers/support/WMTSSublayer.js";
CDN: const WMTSSublayer = await $arcgis.import("@arcgis/core/layers/support/WMTSSublayer.js");
Class: @arcgis/core/layers/support/WMTSSublayer
Since: ArcGIS Maps SDK for JavaScript 4.4
Represents a sublayer in a WMTSLayer.
Constructors new WMTSSublayer(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 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.
The full extent of the layer.
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.
Since: ArcGIS Maps SDK for JavaScript 4.27 WMTSSublayer since 4.4, parent added at 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.
A collection of supported WMTSStyles as retrieved from the GetCapabilities request.
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.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
Parameters
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.
Creates a deep clone of the WMTS sublayer.
Returns
Type 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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue
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
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4