ArcGIS Developers

WmsService Class

class Esri::ArcGISRuntime::WmsService

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

Header: #include <WmsService>
Since: Esri::ArcGISRuntime 100.2
Inherits: Esri::ArcGISRuntime::Object, Esri::ArcGISRuntime::Loadable, and Esri::ArcGISRuntime::RemoteResource

This class was introduced in Esri::ArcGISRuntime 100.2.

Public Functions

WmsService(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
WmsService(const QUrl &url, QObject *parent = nullptr)
virtual ~WmsService() override
QMap<QString, QString> customParameters() const
Esri::ArcGISRuntime::WmsServiceInfo serviceInfo() const
void setCustomParameters(const QMap<QString, QString> &customParameters)
Esri::ArcGISRuntime::WmsVersion version() const

Reimplemented Public Functions

virtual void cancelLoad() override
virtual Esri::ArcGISRuntime::Credential *credential() const override
virtual void load() override
virtual Esri::ArcGISRuntime::Error loadError() const override
virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
virtual Esri::ArcGISRuntime::RequestConfiguration requestConfiguration() const override
virtual void retryLoad() override
virtual void setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration) override
virtual QUrl url() const override


void doneLoading(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

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, WmsLayerInfo, and WmsLayer.

Member Function Documentation

WmsService::WmsService(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Constructor that accepts a URL, a Credential, and an optional parent object.

  • url - The URL of the WMS service.
  • credential - The credential.
  • parent - The parent object for this WmsService (optional).

WmsService::WmsService(const QUrl &url, QObject *parent = nullptr)

Constructor that accepts a URL (url) and an optional parent.

[signal] void WmsService::doneLoading(Esri::ArcGISRuntime::Error loadError)

Signal emitted when this object is done loading.

  • loadError - Details about any error that may have occurred.

Note: If there is a load error it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

[signal] void WmsService::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the load status changes for this object.

See also Loadable.

[override virtual] WmsService::~WmsService()


[override virtual] void WmsService::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Credential *WmsService::credential() const

Reimplements: RemoteResource::credential() const.

Returns the security credential used to access this WmsService.

Only applicable if the service is secured.

QMap<QString, QString> WmsService::customParameters() const

Returns the custom parameters that are applied to WMS requests related to this service.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also setCustomParameters().

[override virtual] void WmsService::load()

Reimplements: Loadable::load().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Error WmsService::loadError() const

Reimplements: Loadable::loadError() const.

See Loadable.

[override virtual] Esri::ArcGISRuntime::LoadStatus WmsService::loadStatus() const

Reimplements: Loadable::loadStatus() const.

See Loadable.

[override virtual] Esri::ArcGISRuntime::RequestConfiguration WmsService::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this task.

See also setRequestConfiguration().

[override virtual] void WmsService::retryLoad()

Reimplements: Loadable::retryLoad().

See Loadable.

Esri::ArcGISRuntime::WmsServiceInfo WmsService::serviceInfo() const

Returns the service info for this service.

A WmsServiceInfo provides the information for browsing and accessing the service contents.

void WmsService::setCustomParameters(const QMap<QString, QString> &customParameters)

Sets the custom parameters that are applied to WMS requests related to this service to customParameters.

customParameters is a map of strings where the key is the parameter's name and the value is 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 function was introduced in Esri::ArcGISRuntime 100.3.

See also customParameters().

[override virtual] void WmsService::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets configuration parameters used for network requests sent by this task to requestConfiguration.

See also requestConfiguration().

[override virtual] QUrl WmsService::url() const

Reimplements: RemoteResource::url() const.

Returns the URL of this WmsService.

Esri::ArcGISRuntime::WmsVersion WmsService::version() const

Returns the version of the WMS service.

Feedback on this topic?