WMTSSublayer

Property Overview

Property Details

declaredClass Stringreadonly inherited

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.

imageFormats String[]

Supported image formats as retrieved from the GetCapabilities request.

layer WMTSLayer

The WMTSLayer to which the sublayer belongs.

parent WMTSLayer

Since: 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

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: 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();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key 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.

Returns

Type	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.

Parameter

json Object A 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.

Returns

Type	Description
*	Returns a new instance of this class.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	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)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A 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");

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.