Class WmsLayer
A Layer that displays data from OGC Web Map Services (WMS).
Namespace: Esri.ArcGISRuntime.Mapping
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class WmsLayer : ImageAdjustmentLayer, INotifyPropertyChanged, ILoadable, ILayerContent, ITimeAwareRemarks
Web Map Service (WMS) is an Open Geospatial Consortium (OGC) standard for delivering map images from an online service. WMS layer displays data from a web service that provides maps in the form of server-rendered images. ArcGIS Runtime supports WMS versions 1.1.0, 1.1.1, and 1.3.0. The service may be hosted in the cloud on ArcGIS Online, on a third party server, or on-premises ArcGIS Server.
Functional characteristics
A WMS service can contain multiple layers in a hierarchy. A Wms layer can be constructed directly with a URL to a service and the uniquely identifying name of the desired layer. Alternatively, a WmsService can be used to programmatically explore the available layers and allow the user to choose layers at run time.
The maps provided by a WMS service use predefined symbology defined by the server. As a result, it is not possible to apply custom renderers or to visualize feature selection. WMS layers can have multiple style options. Your app can choose from the available styles.
Some layers can be marked as opaque, which means that they cover most of the map area and are good candidates for use as a basemap.
WMS layers support identify and time. They do not support selection or query. Note that due to the nature of WMS, it is not possible to retrieve feature geometry from WMS identify results. WMS layers support custom parameters, which can be specified for the service or an individual layer.
Performance characteristics
WMS servers render map images on demand, which can require more server resources than a similar tiled service. WMS requires a service connection at all times.
Sample Code:
Constructors
| Name | Description |
|---|---|
| WmsLayer(Item) | Initializes a new instance of the WmsLayer class from the specified Item. |
| WmsLayer(IEnumerable<WmsLayerInfo>) | Initializes a new instance of the WmsLayer class with the given layers. |
| WmsLayer(Uri, IEnumerable<String>) | Initializes a new instance of the WmsLayer class with the given service URI and layer names. |
Properties
| Name | Description |
|---|---|
| CustomParameters | Gets the dictionary of custom parameters to be sent with WMS requests issued by this layer. |
| FullTimeExtent | Gets the temporal window that encapsulates the instance's complete set of data |
| IsTimeFilteringEnabled | Gets or sets a value indicating whether the instance respects any temporal filters that are applied to it. |
| LayerInfos | Gets a list of WmsLayerInfo objects, describing the selected WMS sublayers. |
| LayerNames | Gets a list of names of visible WMS layers. |
| PreferredImageFormat | Gets or sets the preferred image format of this WMS layer. |
| RefreshInterval | Gets or sets the refresh interval on this WMS layer. |
| Source | Gets the WMS service endpoint Uri used by this layer. |
| Sublayers | Gets a list of sublayers for this WMS layer. |
| SupportsTimeFiltering | Gets a value indicating whether the instance supports filtering its data based on time. |
| TimeInterval | Gets a temporal value that represents the suggested temporal interval to use when sequentially stepping through the instance's data by time |
| TimeOffset | Gets or sets the amount of time by which to offset the temporal values of data points in this instance when displaying the data in a GeoView |
| Version | Gets the version of the WMS specification used by this layer. |
Events
| Name | Description |
|---|---|
| FullTimeExtentChanged | Raised when the FullTimeExtent of the instance's data changes |
See Also
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.2.1 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.2.1 - 100.15 |
| Xamarin.iOS | 100.2.1 - 100.15 |
| UWP | 100.2.1 - 100.15 |