WMTSStyle

AMD: require(["esri/layers/support/WMTSStyle"], (WMTSStyle) => { /* code goes here */ });
ESM: import WMTSStyle from "@arcgis/core/layers/support/WMTSStyle";
Class: esri/layers/support/WMTSStyle
Inheritance: WMTSStyle Accessor
Since: ArcGIS API 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
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

Description for the WMTS style.

more detailsWMTSStyle
Stringmore details

The unique ID assigned to the style.

more detailsWMTSStyle
Stringmore details

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

more detailsWMTSStyle
Stringmore details

The title of the WMTS style.

more detailsWMTSStyle

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API 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

Name Return Type Summary Class
WMTSStylemore details

Creates a deep clone of the WMTSStyle.

more detailsWMTSStyle
*more details

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

more detailsWMTSStyle
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsWMTSStyle

Method Details

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