Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: WMSLayerInfo
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/WMSLayerInfo"], function(WMSLayerInfo) { /* code goes here */ });
Description
(Added at v2.1)
The WMSLayerInfo class defines and provides information about layers in a WMS service.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new WMSLayerInfo(options?) | Creates a new WMSLayerInfo object. |
Properties
| Name | Type | Summary |
|---|---|---|
| allExtents | Extent[] | All bounding boxes defined for the layer. |
| description | String | The layer description defines the value of the Abstract capabilities property. |
| extent | Extent | The layer extent. |
| legendURL | String | Contains the value of the LegendURL capabilities property. |
| name | String | The layer name. |
| queryable | Boolean | Returns true if the layer can be queried and the service supports GetFeatureInfo with either text/html or text/plain formats. |
| showPopup | Boolean | Indicates if this layer should be included in the popup. |
| spatialReferences | Number[] | An array of WKIDs of all spatial references defined for the layer. |
| subLayers | WMSLayerInfo[] | WMSLayerInfos of the layer's sub layers. |
| title | String | The layer title. |
Constructor Details
Creates a new WMSLayerInfo object.
Parameters:
< |
Optional | See options list for parameters. |
options properties: < |
Optional | All the bounding extents defined for this layer. |
< |
Optional | A description of the WMS layer. |
< |
Optional | The extent of the WMS Layer. |
< |
Optional | The URL to the legend image. |
< |
Required | The name of the WMS layer. This is used to set layer visibility. |
< |
Optional | Returns true if the layer can be queried and the service supports GetFeatureInfo with either text/html or text/plain formats. |
< |
Optional | Indicates if this layer should be included in the popup. |
< |
Optional | All the spatial references defined for this layer. |
< |
Optional | WMSLayerInfos of the layer's sub layers. |
< |
Optional | The title of the WMS layer. |
Sample:
require([
"esri/layers/WMSLayerInfo", ...
], function(WMSLayerInfo, ... ) {
var layer = new WMSLayerInfo({name:'1',title:'Rivers'});
...
});
Property Details
<Extent[]
Extent[]All bounding boxes defined for the layer. (Added at v3.13)
<String
StringThe layer description defines the value of the Abstract capabilities property.
<Extent
ExtentThe layer extent.
<String
StringContains the value of the
LegendURL capabilities property. (Added at v3.13)<String
StringThe layer name. The layer name must be included in the visibleLayers list.
<Boolean
BooleanReturns
true if the layer can be queried and the service supports GetFeatureInfo with either text/html or text/plain formats (Added at v3.17)<Boolean
BooleanIndicates if this layer should be included in the popup. (Added at v3.17)
Default value:
false<Number[]
Number[]An array of WKIDs of all spatial references defined for the layer. (Added at v3.13)
<WMSLayerInfo[]
WMSLayerInfo[]WMSLayerInfos of the layer's sub layers.
<String
StringThe layer title.