WmsService

An object that represents the service for an WMS Service.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(url: String)

Creates a WmsService with provided URL to the service. To specify a preferred WMS version, set the 'VERSION' parameter in the 'GetCapabilities' URL for the service.

Properties

Link copied to clipboard

These parameters are appended to GetCapabilities, GetMap, and GetFeatureInfo requests. If a parameter with the same name is defined in a layer's custom parameters, then layer-specific values take precedence over service-wide values. Parameters intended for GetCapabilities requests should be set before the service is loaded. If used with the CustomParameters property on WmsLayer, duplicate parameters in this service CustomParameters will not take precedence.

Link copied to clipboard

The WmsServiceInfo. The WMS service info is returned as WmsServiceInfo type.

Link copied to clipboard
val url: String

The service metadata URL.

Link copied to clipboard

The version of the WMS service. This API supports the following 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.