WmsService

An Open Geospatial Consortium (OGC) Web Map Service (WMS). The OGC WMS standard[https://www.ogc.org/standard/wms/] is an international specification for requesting geo-registered map images from one or more distributed geospatial databases. The service may be hosted in ArcGIS Enterprise or in a third party server. You can construct a WmsService using the URL for a service's GetCapabilities operation. Once loaded, you can browse its metadata using WmsService.serviceInfo and access its layers using the WmsServiceInfo.layerInfos collection.

WMS versions 1.3.0, 1.1.1, and 1.1.0 are supported. The latest supported WMS version is set as the default. If you want to specify a different WMS version, set the VERSION parameter in the GetCapabilities URL for the service. For more information, see https://enterprise.arcgis.com/en/server/latest/publish-services/windows/communicating-with-a-wms-service-in-a-web-browser.htm#GUID-5B1493CF-E8F2-4EAA-9EE0-E96265DA2ED3.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(url: String)

Creates a WmsService with the specified URL to the service. If you want to specify a different WMS version, set the VERSION parameter in the GetCapabilities URL for the service. For more information, see https://enterprise.arcgis.com/en/server/latest/publish-services/windows/communicating-with-a-wms-service-in-a-web-browser.htm#GUID-5B1493CF-E8F2-4EAA-9EE0-E96265DA2ED3.

Properties

Link copied to clipboard

Custom parameters that are appended to GetCapabilities, GetMap, and GetFeatureInfo WMS requests. 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.

Link copied to clipboard

The information for browsing and accessing the WmsService content.

Link copied to clipboard
val url: String

The WMS service's URL.

Link copied to clipboard

The version of the WMS specification used when communicating with this service. This API supports WMS versions: 1.3.0, 1.1.1, and 1.1.0. By default the value is the latest supported WMS version.

Inherited properties

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.