WmsService Class

  • WmsService
  • class Esri::ArcGISRuntime::WmsService

    An Open Geospatial Consortium (OGC) Web Map Service (WMS). More...

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

    Public Functions

    WmsService(const QUrl &url, QObject *parent = nullptr)
    WmsService(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, 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(const Esri::ArcGISRuntime::Error &loadError)
    void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Detailed Description

    The OGC WMS standard 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 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 Parameters of a WMS GetCapabilities request URL.

    Member Function Documentation

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

    Creates a WmsService with the specified URL to the service.

    • url - URL of the OGC WMS service.
    • parent - The optional parent QObject.

    If you want to specify a different WMS version, set the VERSION parameter in the GetCapabilities URL for the service. For more information, see Parameters of a WMS GetCapabilities request URL.

    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).

    [override virtual] WmsService::~WmsService()


    [override virtual] void WmsService::cancelLoad()

    Reimplements: Loadable::cancelLoad().

    Cancels loading metadata for the object.

    Cancels loading the metadata if the object is loading

    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.

    [since Esri::ArcGISRuntime 100.3] QMap<QString, QString> WmsService::customParameters() const

    Returns 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.

    If a parameter with the same name is defined in a layer's custom parameters, then the layer-specific values take precedence over service-wide values.

    This function was introduced in Esri::ArcGISRuntime 100.3.

    See also setCustomParameters().

    [signal] void WmsService::doneLoading(const 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.

    [override virtual] void WmsService::load()

    Reimplements: Loadable::load().

    Loads the metadata for the object asynchronously.

    Loads the metadata if the object is not loaded

    See Loadable.

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

    Reimplements: Loadable::loadError() const.

    Returns the load error.

    See Loadable.

    See also Error.

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

    Reimplements: Loadable::loadStatus() const.

    Returns the load status.

    See Loadable.

    See also LoadStatus.

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

    Signal emitted when the load status changes for this object.

    See also 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().

    Loads or retries loading metadata for the object asynchronously.

    Will retry loading the metadata if the object is failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.

    See Loadable.

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

    Returns the information for browsing and accessing the WmsService content.

    [since Esri::ArcGISRuntime 100.3] void WmsService::setCustomParameters(const QMap<QString, QString> &customParameters)

    ets the customParameters to customParameters.

    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 WMS service's URL.

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

    Returns 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.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.