WMTSSublayer

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

Represents a sublayer in a WMTSLayer.

Constructors

new WMTSSublayer(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 sublayer.

more detailsWMTSSublayer
Extentmore details

The full extent of the layer.

more detailsWMTSSublayer
Stringmore details

The unique ID assigned to the sublayer.

more detailsWMTSSublayer
Stringmore details

The map image format (MIME type) to request.

more detailsWMTSSublayer
String[]more details

Supported image formats as retrieved from the GetCapabilities request.

more detailsWMTSSublayer
WMTSLayermore details

The WMTSLayer to which the sublayer belongs.

more detailsWMTSSublayer
Stringmore details

The WMTSStyle to request.

more detailsWMTSSublayer
Collection<WMTSStyle>more details

A collection of supported WMTSStyles as retrieved from the GetCapabilities request.

more detailsWMTSSublayer
TileMatrixSetmore details

The TileMatrixSet to request.

more detailsWMTSSublayer
Stringmore details

The id of the TileMatrixSet to request.

more detailsWMTSSublayer
Collection<TileMatrixSet>more details

A collection of supported TileMatrixSets.

more detailsWMTSSublayer
Stringmore details

The title of the WMTS sublayer used to identify it in places such as the LayerList and Legend widgets.

more detailsWMTSSublayer

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

styleId String

The WMTSStyle to request. Defaults to the id of the first item in styles. Should be one of the supported styles.

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

Name Return Type Summary Class
WMTSSublayermore details

Creates a deep clone of the WMTS sublayer.

more detailsWMTSSublayer
*more details

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

more detailsWMTSSublayer
Objectmore details

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

more detailsWMTSSublayer

Method Details

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