require(["esri/layers/support/WMTSStyle"], function(WMTSStyle) { /* code goes here */ });
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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

Description for the WMTS style.

more details
more detailsWMTSStyle
String

The unique ID assigned to the style.

more details
more detailsWMTSStyle
String

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

more details
more detailsWMTSStyle
String

The title of the WMTS style.

more details
more detailsWMTSStyle

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

descriptionString

Description for the WMTS style. This defaults to the value of the Abstract property from the WMTS GetCapabilities request.

The unique ID assigned to the style.

legendUrlString

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.

titleString

The title of the WMTS style.

Method Overview

NameReturn TypeSummaryClass
WMTSStyle

Creates a deep clone of the WMTSStyle.

more details
more detailsWMTSStyle
*

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

more details
more detailsWMTSStyle
Object

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

more details
more detailsWMTSStyle

Method Details

clone(){WMTSStyle}

Creates a deep clone of the WMTSStyle.

Returns:
TypeDescription
WMTSStyleA 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 a product in the ArcGIS platform. 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:
TypeDescription
*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() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.