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

The name of the class.

more details
more detailsAccessor
String

Description for the WMTS sublayer.

more details
more detailsWMTSSublayer
Extent

The full extent of the layer.

more details
more detailsWMTSSublayer
String

The unique ID assigned to the sublayer.

more details
more detailsWMTSSublayer
String

The map image format (MIME type) to request.

more details
more detailsWMTSSublayer
String[]

Supported image formats as retrieved from the GetCapabilities request.

more details
more detailsWMTSSublayer
WMTSLayer

The WMTSLayer to which the sublayer belongs.

more details
more detailsWMTSSublayer
String

The WMTSStyle to request.

more details
more detailsWMTSSublayer
Collection<WMTSStyle>

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

more details
more detailsWMTSSublayer
TileMatrixSet

The TileMatrixSet to request.

more details
more detailsWMTSSublayer
String

The id of the TileMatrixSet to request.

more details
more detailsWMTSSublayer
Collection<TileMatrixSet>

A collection of supported TileMatrixSets.

more details
more detailsWMTSSublayer
String

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

more details
more detailsWMTSSublayer

Property Details

declaredClassStringreadonly inherited

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

descriptionString

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

fullExtentExtent

The full extent of the layer.

The unique ID assigned to the sublayer. If not set by the developer, it is automatically generated when the layer is loaded.

imageFormatString

The map image format (MIME type) to request. Defaults to the first item in imageFormats. Must be one of the supported imageFormats.

imageFormatsString[]

Supported image formats as retrieved from the GetCapabilities request.

The WMTSLayer to which the sublayer belongs.

styleIdString

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.

tileMatrixSetTileMatrixSet

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.

tileMatrixSetIdString

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.

tileMatrixSetsCollection<TileMatrixSet>

A collection of supported TileMatrixSets.

titleString

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

NameReturn TypeSummaryClass
WMTSSublayer

Creates a deep clone of the WMTS sublayer.

more details
more detailsWMTSSublayer
*

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 detailsWMTSSublayer
Object

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

more details
more detailsWMTSSublayer

Method Details

clone(){WMTSSublayer}

Creates a deep clone of the WMTS sublayer.

Returns:
TypeDescription
WMTSSublayerA 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 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.