Property Overview

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 WMS sublayer. This defaults to the value of the Abstract property from the WMS GetCapabilities request.

fullExtent Extent

The full extent of the layer.

id Number

The id for the WMS sublayer.

layer WMSLayer

The WMSLayer to which the sublayer belongs.

legendEnabled Boolean

Indicates whether the layer will be included in the legend. When false, the layer will be excluded from the legend.

Default Value:true

legendUrl String

A string url pointing to a legend image for the layer.

maxScale Number

Since: ArcGIS API for JavaScript 4.14

The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of zero means the layer does not have a maximum scale.

Default Value:0

minScale Number

Since: ArcGIS API for JavaScript 4.14

The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of zero means the layer does not have a minimum scale.

Default Value:0

name String

Name of the WMS sublayer. This defaults to the value of the Name property from the WMS GetCapabilities request.

popupEnabled Boolean

Indicates whether to display popups when features in the layer are clicked.

Default Value:false

queryable Boolean

Indicates if the layer can be queried, i.e. the service supports GetFeatureInfo with either text/html or text/plain formats.

Default Value:false

spatialReferences Number[]

List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request.

sublayers Collection<WMSSublayer>

A collection of WMSSublayers.

title String

The title of the WMS 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 WMS GetCapabilities request.

visible Boolean

Indicates if the layer is visible in the view.

Method Overview

Method Details

clone(){WMSSublayer}

Creates a deep clone of the WMS sublayer.

Returns:

Type	Description
WMSSublayer	A deep clone of the WMS sublayer instance that invoked this method.