WMSSublayer
require(["esri/layers/support/WMSSublayer"], function(WMSSublayer) { /* code goes here */ });esri/layers/support/WMSSublayerRepresents a sublayer in a WMSLayer.
Constructors
- new WMSSublayer(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | Description for the WMS sublayer. more details | more details | WMSSublayer | |
| Extent | The full extent of the layer. more details | more details | WMSSublayer | |
| Number | The id for the WMS sublayer. more details | more details | WMSSublayer | |
| WMSLayer | The WMSLayer to which the sublayer belongs. more details | more details | WMSSublayer | |
| Boolean | Indicates whether the layer will be included in the legend. more details | more details | WMSSublayer | |
| String | A string url pointing to a legend image for the layer. more details | more details | WMSSublayer | |
| String | Name of the WMS sublayer. more details | more details | WMSSublayer | |
| Boolean | Indicates whether to display popups when features in the layer are clicked. more details | more details | WMSSublayer | |
| Boolean | Indicates if the layer can be queried, i.e. more details | more details | WMSSublayer | |
| Number[] | List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request. more details | more details | WMSSublayer | |
| Collection<WMSSublayer> | A collection of WMSSublayers. more details | more details | WMSSublayer | |
| String | The title of the WMS sublayer used to identify it in places such as the LayerList and Legend widgets. more details | more details | WMSSublayer | |
| Boolean | Indicates if the layer is visible in the view. more details | more details | WMSSublayer |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- 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.
- idNumber
The id for the WMS sublayer.
- 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.
- sublayersCollection<WMSSublayer>
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
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| WMSSublayer | Creates a deep clone of the WMS sublayer. more details | more details | WMSSublayer |
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.