WMS Layer (WMS)

A layer consuming a Web Map Service (WMS). The WMS specification is an international specification for serving and consuming dynamic maps on the web.

Referenced by: baseMapLayer, operationalLayers

Properties

Property	Details
blendMode	Blend modes are used to create various effects by blending colors of top and background layers. normal blend mode is the default. Valid values: average, color, color-burn, color-dodge, darken, destination-atop, destination-in, destination-out, destination-over, difference, exclusion, hard-light, hue, invert, lighten, lighter, luminosity, minus, multiply, normal, overlay, plus, reflect, saturation, screen, soft-light, source-atop, source-in, source-out, vivid-light, xor
copyright	A string containing copyright and access information for a WMS layer. This is copied from the capabilities document exposed by the WMS service.
customLayerParameters	A sequence of custom parameters to WMS layer requests. These parameters are applied to GetMap and GetFeatureInfo requests. The customLayerParameters property takes precedence if customParameters is also present.
customParameters	A sequence of custom parameters to all WMS requests. These parameters are applied to GetCapabilities, GetMap, and GetFeatureinfo requests. If used with the customLayerParameters property, customParameters will not take precedence.
effect	Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.
extent[]	The minimum bounding rectangle, in decimal degrees, of the area covered by the layer as specified in the capabilities.
featureInfoFormat	Format of the feature, e.g.text/plain
featureInfoUrl	The URL for the WMS GetFeatureInfo call.
format	A string containing the image format to be requested from a WMS service. Default is png. Valid values: bmp gif jpg png svg
id	A unique identifying string for the layer.
isReference	This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false).
itemId	Unique string value indicating an item registered in ArcGIS Online or your organization's portal.
layers[]	An array of layer objects from the WMS service.
layerType	String indicating the layer type. Valid value of this property WMS
mapUrl	A string containing the URL of the WMS map. When using a WMS layer, you should also supply the url property. mapUrl is the URL returned by the capabilities to be used for the getMap requests.
maxHeight	A number defining the maximum height, in pixels, that should be requested from the service.
maxScale	A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator.
maxWidth	A number defining the maximum width, in pixels, that should be requested from the service.
minScale	A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator.
opacity	The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
refreshInterval	Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.
showLegend	Boolean value indicating whether to display the layer in the legend. Default value is true.
spatialReferences[]	An array of numbers containing well-known IDs for spatial references supported by the service.
timeAnimation	Indicates whether to disable time animation if the layer supports it.
title	A user-friendly string title for the layer that can be used in a table of contents.
type	Deprecated. Use layerType instead.
url	The URL to the WMS service (getCapabilities URL).
version	A string containing the version number of the service.
visibility	Boolean property determining whether the layer is initially visible in the web map.
visibilityTimeExtent	Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.
visibleLayers[]	An array of layers that should appear visible. The array contains the names of the visible layers.

Additional information

Live sample web maps using a WMS service as an operationalLayer. Live sample web maps showing the WMS as a baseMapLayer.

WMS Layer (WMS) Example

{
  "id": "wms_3449",
  "url": "http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi",
  "visibility": true,
  "visibleLayers": [
    "nexrad-n0r"
  ],
  "opacity": 1,
  "title": "IEM WMS Service",
  "layerType": "WMS",
  "version": "1.3.0",
  "itemId": "0217f8067457410a998fc9293563ba94",
  "mapUrl": "http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi",
  "layers": [],
  "spatialReferences": [
    900913,
    4326,
    102100,
    3857
  ],
  "extent": [
    [
      -126,
      24
    ],
    [
      -66,
      50
    ]
  ],
  "maxWidth": 2048,
  "maxHeight": 2048
}