WmsLayerInfo Class

  • WmsLayerInfo
  • class Esri::ArcGISRuntime::WmsLayerInfo

    Metadata about an individual Web Map Service (WMS) layer within a WMS service. More...

    Header: #include <WmsLayerInfo.h>
    Since: Esri::ArcGISRuntime 100.2

    Public Functions

    WmsLayerInfo(const Esri::ArcGISRuntime::WmsLayerInfo &other)
    WmsLayerInfo(Esri::ArcGISRuntime::WmsLayerInfo &&other)
    QString description() const
    Esri::ArcGISRuntime::Envelope extent() const
    int fixedImageHeight() const
    int fixedImageWidth() const
    bool isEmpty() const
    bool isOpaque() const
    bool isQueryable() const
    QStringList keywords() const
    QString name() const
    QList<Esri::ArcGISRuntime::SpatialReference> spatialReferences() const
    QStringList styles() const
    QList<Esri::ArcGISRuntime::WmsLayerInfo> sublayerInfos() const
    QString title() const
    Esri::ArcGISRuntime::WmsLayerInfo &operator=(const Esri::ArcGISRuntime::WmsLayerInfo &other)
    Esri::ArcGISRuntime::WmsLayerInfo &operator=(Esri::ArcGISRuntime::WmsLayerInfo &&other)

    Detailed Description

    You can obtain a WmsLayerInfo from the WmsServiceInfo::layerInfos collection of a loaded WmsService.

    Member Function Documentation


    Default constructor.

    This constructor is provided for convenience only.

    WmsLayerInfo::WmsLayerInfo(const Esri::ArcGISRuntime::WmsLayerInfo &other)

    Copy constructor from other WmsLayerInfo.

    WmsLayerInfo::WmsLayerInfo(Esri::ArcGISRuntime::WmsLayerInfo &&other)

    Move constructor from other WmsLayerInfo.



    QString WmsLayerInfo::description() const

    Returns a brief narrative description (abstract) of this WMS layer.

    Esri::ArcGISRuntime::Envelope WmsLayerInfo::extent() const

    Returns the approximate bounds of the area covered by the WMS layer.

    int WmsLayerInfo::fixedImageHeight() const

    Returns the height of map images the service is capable of producing (in pixels).

    If the value is nonzero, this indicates that the server can only produce map images at the fixed height. If the value is zero, the server can produce maps of arbitrary dimensions.

    int WmsLayerInfo::fixedImageWidth() const

    Returns the width of map images the service is capable of producing (in pixels).

    If the value is nonzero, this indicates that the server can only produce map images at the fixed width. If the value is zero, the server can produce maps of arbitrary dimensions.

    bool WmsLayerInfo::isEmpty() const

    Returns whether the object is empty.

    bool WmsLayerInfo::isOpaque() const

    Returns true if the WmsLayer content should be considered opaque, false otherwise.

    The WMS layer's opaque property describes the layer's data content, not the picture format of the map response. A true value indicates that the map data are mostly or completely opaque. A false value indicates that the map data represent vector features that probably do not completely fill space. In practice, a layer with opaque set to true is a good candidate for use as a basemap.

    bool WmsLayerInfo::isQueryable() const

    Returns true if the WMS layer is queryable, false otherwise.

    QStringList WmsLayerInfo::keywords() const

    Returns an unordered collection of commonly used or formalized words or phrases which describe the layer's dataset.

    The keywords are returned in an QList of QString.

    QString WmsLayerInfo::name() const

    Returns the layer's uniquely-identifying name.

    A WMS layer can be displayed if it has a name. If the WMS layer has a name, its sublayers (sublayerInfos) are displayed if the WMS layer is displayed. If the WMS layer does not have a name but has a title, it is just a category for other sublayers.

    QList<Esri::ArcGISRuntime::SpatialReference> WmsLayerInfo::spatialReferences() const

    Returns an unordered collection of spatial references supported by the layer.

    Spatial reference systems not supported by this API are omitted. Spatial references with multiple well-known IDs, such as CRS:84 and EPSG:4326, may appear multiple times. The collection may be empty.

    QStringList WmsLayerInfo::styles() const

    Returns a collection of WMS styles that can be applied to this layer.

    Styles are server-defined options for how the layer and its information are displayed. Note that the order of styles returned does not indicate which style is the default. Styles can be applied using WmsSublayer::currentStyle.

    QList<Esri::ArcGISRuntime::WmsLayerInfo> WmsLayerInfo::sublayerInfos() const

    Returns the collection of sublayers of the WMSLayer.

    The WMS sublayer infos are returned in a QList containing WmsLayerInfo types.

    QString WmsLayerInfo::title() const

    Returns the layer's human-readable title.

    The title may not be unique. A layer with a title but no name describes is a container for sublayers.

    Esri::ArcGISRuntime::WmsLayerInfo &WmsLayerInfo::operator=(const Esri::ArcGISRuntime::WmsLayerInfo &other)

    Assignment operator from other WmsLayerInfo.

    Esri::ArcGISRuntime::WmsLayerInfo &WmsLayerInfo::operator=(Esri::ArcGISRuntime::WmsLayerInfo &&other)

    Move operator from other WmsLayerInfo.

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