WMTSSublayer | References | ArcGIS Maps SDK for JavaScript

import WMTSSublayer from "@arcgis/core/layers/support/WMTSSublayer.js";

Inheritance:: WMTSSublayer→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.4

Represents a sublayer in a WMTSLayer.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`WMTSSublayerProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`description`	`string`
`fullExtent`	`Extent \| null \| undefined`
`id`	`string`
`imageFormat`	`string`
`imageFormats`	`string[] \| null \| undefined`
`layer`	`WMTSLayer \| null \| undefined`
`parent`	`WMTSLayer \| null \| undefined`
`styleId`	`string`
`styles`	`Collection<WMTSStyle> \| null \| undefined`
`tileMatrixSet` readonly	`TileMatrixSet \| null \| undefined`
`tileMatrixSetId`	`string`
`tileMatrixSets`	`Collection<TileMatrixSet> \| null \| undefined`
`title`	`string \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

description

Property

Type: string

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

fullExtent

autocast Property

Type: Extent | null | undefined

The full extent of the layer.

id

Property

Type: string

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

imageFormat

Property

Type: string

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

imageFormats

Property

Type: string[] | null | undefined

Supported image formats as retrieved from the GetCapabilities request.

layer

Property

Type: WMTSLayer | null | undefined

The WMTSLayer to which the sublayer belongs.

parent

Property

Type: WMTSLayer | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.27

The parent WMTSLayer to which the sublayer belongs.

styleId

Property

Type: string

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

styles

autocast Property

Type: Collection<WMTSStyle> | null | undefined

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

tileMatrixSet

readonly Property

Type: TileMatrixSet | null | undefined

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

Property

Type: 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

autocast Property

Type: Collection<TileMatrixSet> | null | undefined

A collection of supported TileMatrixSets.

title

Property

Type: string | null | undefined

The title of the WMTS sublayer used to identify it in places such as the LayerList and Legend. This defaults to the value of the Title property from the WMTS GetCapabilities request.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): WMTSSublayer`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): WMTSSublayer

Creates a deep clone of the WMTS sublayer.

Returns: WMTSSublayer
A deep clone of the WMTS sublayer instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.