require(["esri/layers/support/WMSSublayer"], function(WMSSublayer) { /* code goes here */ });
Class: esri/layers/support/WMSSublayer
Since: ArcGIS API for JavaScript 4.4

Represents a sublayer in a WMSLayer.

Constructors

new WMSSublayer(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

Description for the WMS sublayer.

more details
more detailsWMSSublayer
Extent

The full extent of the layer.

more details
more detailsWMSSublayer
Number

The id for the WMS sublayer.

more details
more detailsWMSSublayer
WMSLayer

The WMSLayer to which the sublayer belongs.

more details
more detailsWMSSublayer
Boolean

Indicates whether the layer will be included in the legend.

more details
more detailsWMSSublayer
String

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

more details
more detailsWMSSublayer
String

Name of the WMS sublayer.

more details
more detailsWMSSublayer
Boolean

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

more details
more detailsWMSSublayer
Boolean

Indicates if the layer can be queried, i.e.

more details
more detailsWMSSublayer
Number[]

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

more details
more detailsWMSSublayer
Collection<WMSSublayer>

A collection of WMSSublayers.

more details
more detailsWMSSublayer
String

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

more details
more detailsWMSSublayer
Boolean

Indicates if the layer is visible in the view.

more details
more detailsWMSSublayer

Property Details

descriptionString

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

fullExtentExtent

The full extent of the layer.

The id for the WMS sublayer.

The WMSLayer to which the sublayer belongs.

legendEnabledBoolean

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

Default Value: true

legendUrlString

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

nameString

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

popupEnabledBoolean

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

Default Value: false

queryableBoolean

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

Default Value: false

spatialReferencesNumber[]

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

A collection of WMSSublayers.

titleString

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.

visibleBoolean

Indicates if the layer is visible in the view.

Method Overview

NameReturn TypeSummaryClass
WMSSublayer

Creates a deep clone of the WMS sublayer.

more details
more detailsWMSSublayer

Method Details

clone(){WMSSublayer}

Creates a deep clone of the WMS sublayer.

Returns:
TypeDescription
WMSSublayerA deep clone of the WMS sublayer instance that invoked this method.

API Reference search results

NameTypeModule

There were no match results from your search criteria.