WMTSStyle
require(["esri/layers/support/WMTSStyle"], function(WMTSStyle) { /* code goes here */ });esri/layers/support/WMTSStyleContains information about the WMTS Style for WMTSSublayer. Valid WMTS styles are advertised in WMTS service metadata (GetCapabilities response).
Constructors
- new WMTSStyle(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | Description for the WMTS style. more details | more details | WMTSStyle | |
| String | The unique ID assigned to the style. more details | more details | WMTSStyle | |
| String | The URL to the legend which gets used in Legend widget. more details | more details | WMTSStyle | |
| String | The title of the WMTS style. more details | more details | WMTSStyle |
Property Details
- Since: ArcGIS API for JavaScript 4.7
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.
- idString
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
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| WMTSStyle | Creates a deep clone of the WMTSStyle. more details | more details | WMTSStyle | |
| * | 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 details | WMTSStyle | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | WMTSStyle |
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 a product in the ArcGIS platform. The object passed into the input
jsonparameter 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 ObjectA 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() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.