WMTSStyle

AMD: require(["esri/layers/support/WMTSStyle"], (WMTSStyle) => { /* code goes here */ });
ESM: import WMTSStyle from "@arcgis/core/layers/support/WMTSStyle.js";
Class: esri/layers/support/WMTSStyle
Inheritance: WMTSStyle Accessor
Since: ArcGIS Maps SDK for JavaScript 4.4

Contains information about the WMTS Style for WMTSSublayer. Valid WMTS styles are advertised in WMTS service metadata (GetCapabilities response).

Constructors

new WMTSStyle(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
String

Description for the WMTS style.

more details
WMTSStyle
String

The unique ID assigned to the style.

more details
WMTSStyle
String

The URL to the legend which gets used in Legend widget.

more details
WMTSStyle
String

The title of the WMTS style.

more details
WMTSStyle

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 style. This defaults to the value of the Abstract property from the WMTS GetCapabilities request.

id String

The unique ID assigned to the style.

legendUrl String

The URL to the legend which gets used in Legend widget. This defaults to the value of the LegendURL property from the WMTS GetCapabilities request.

title String

The title of the WMTS style.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
WMTSStyle

Creates a deep clone of the WMTSStyle.

more details
WMTSStyle
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
WMTSStyle
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
WMTSStyle

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(){WMTSStyle}

Creates a deep clone of the WMTSStyle.

Returns
Type Description
WMTSStyle A deep clone of the WMTSStyle 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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.