ArcGIS Developers

WmsService QML Type

Represents an OGC Web Map Service (WMS). More...

Import Statement: import Esri.ArcGISRuntime 100.11
Since: Esri.ArcGISRuntime 100.2





Detailed Description

The OGC WMS standard describes an implementation for requesting geo-registered map images from one or more distributed geospatial databases.

The WmsService is constructed using the URL of the service and once the load task completes (see Loadable) allows the user to browse for predefined content via the serviceInfo.

A WMS service may also host several layers, each of which can be described by a WmsLayerInfo.

See also Loadable, RemoteResource, Loadable, WmsLayerInfo, and WmsLayer.

Property Documentation

credential : Credential

Returns the security credential used to access this WmsService.

Only applicable if the service is secured.

customParameters : jsobject

Returns key/value pairs representing the custom parameters that are applied to the WMS requests related to this service.

The key and value for each key/value pair must be strings, where the key is the parameter's name and the value the parameter's value.

When making a WMS request, only parameters required by the service are included by default. Setting custom parameters will allow you to specify any additional parameters, such as API keys or user credentials, to the service. These parameters will be appended to GetCapabilities, GetMap, and GetFeatureInfo requests. Parameters intended for GetCapabilities requests should be set before the service is loaded.

When used together with a WmsLayer, if a parameter with the same name is defined in the layer's custom parameters, then layer-specific values will take precedence over service-wide parameter values.

This property was introduced in Esri.ArcGISRuntime 100.3.

loadError : Error

Returns the loadError of the WmsService (read-only).

loadStatus : Enums.LoadStatus

Returns the loadStatus of the WmsService (read-only).

See also Enums.LoadStatus.

requestConfiguration : RequestConfiguration

The RequestConfiguration in use by this task.

serviceInfo : WmsServiceInfo

The WmsServiceInfo for this service.

url : url

The URL of this WmsService.

version : Enums.WmsVersion

Returns the version of the WMS service (read-only).

See also Enums.WmsVersion.

Signal Documentation


Emitted when the credential property changes.

Note: The corresponding handler is onCredentialChanged.


Emitted when the customParameters property changes.

Note: The corresponding handler is onCustomParametersChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.


Emitted when the loadError property changes.

Note: The corresponding handler is onLoadErrorChanged.


Emitted when the loadStatus property changes.

Note: The corresponding handler is onLoadStatusChanged.


Emitted when the requestConfiguration property changes.

Note: The corresponding handler is onRequestConfigurationChanged.


Emitted when the serviceInfo property changes.

Note: The corresponding handler is onServiceInfoChanged.


Emitted when the url property changes.

Note: The corresponding handler is onUrlChanged.


Emitted when the version property changes.

Note: The corresponding handler is onVersionChanged.

Method Documentation

void cancelLoad()

See Loadable.

void load()

See Loadable.

void retryLoad()

See Loadable.

Feedback on this topic?