Skip To Content ArcGIS for Developers Sign In Dashboard

WmsLayerInfo Class

(Esri::ArcGISRuntime::WmsLayerInfo)

Information about a WMS layer as described by a WMS service. More...

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

Public Functions

WmsLayerInfo()
WmsLayerInfo(const WmsLayerInfo &other)
WmsLayerInfo(WmsLayerInfo &&other)
~WmsLayerInfo()
QString description() const
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<SpatialReference> spatialReferences() const
QStringList styles() const
QList<WmsLayerInfo> sublayerInfos() const
QString title() const
WmsLayerInfo &operator=(const WmsLayerInfo &other)
WmsLayerInfo &operator=(WmsLayerInfo &&other)

Detailed Description

Information about a WMS layer as described by a WMS service.

A list of available layer infos may be obtained from the service info of a loaded wms service.

Member Function Documentation

WmsLayerInfo::WmsLayerInfo()

Default constructor.

This constructor is provided for convenience only.

WmsLayerInfo::WmsLayerInfo(const WmsLayerInfo &other)

Copy constructor from other WmsLayerInfo.

WmsLayerInfo::WmsLayerInfo(WmsLayerInfo &&other)

Move constructor from other WmsLayerInfo.

WmsLayerInfo::~WmsLayerInfo()

Destructor.

QString WmsLayerInfo::description() const

Returns the description of this layer.

Envelope WmsLayerInfo::extent() const

Returns the geographic extent of this layer.

int WmsLayerInfo::fixedImageHeight() const

Returns the fixed image height specified for this layer (in pixels).

When present in WMS GetCapabilities response, a non-zero fixedImageHeight attribute indicates that the server is not able to produce a map of this layer at a height different from the indicated height.

int WmsLayerInfo::fixedImageWidth() const

Returns the fixed image width specified for this layer (in pixels).

When present in WMS GetCapabilities response, a non-zero fixedImageWidth attribute indicates that the server is not able to produce a map of this layer at a width different from the indicated width.

bool WmsLayerInfo::isEmpty() const

Returns whether the object is empty.

bool WmsLayerInfo::isOpaque() const

Returns a value indicating whether the WMS layer's content should be considered "opaque".

The WMS layer opaque property describes the layer's data content, not the picture format of the map response. A true value indicates map data are mostly or completely opaque. A false value indicates 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 if the service is queryable.

QStringList WmsLayerInfo::keywords() const

Returns an unordered list of commonly used or formalized words or phrases used to describe the layer's dataset. May be empty.

QString WmsLayerInfo::name() const

Returns the name of the service.

QList<SpatialReference> WmsLayerInfo::spatialReferences() const

Returns an unordered list of SpatialReferences listed for this WMS layer.

Spatial reference systems not supported by ArcGIS Runtime API are omitted. Spatial references with multiple well-known IDs (such as CRS:84 and EPSG:4326) are only listed once. May be empty.

Every named WMS layer is available in one or more spatial reference systems. The root WmsLayerInfo lists spatial references common to all sublayers. Sublayers inherit all spatial references from their parent layer, and may specify additional ones.

Only the spatial references specifically listed for this WMS layer are included in this list. To get a complete set of available spatial references for this WMS layer, combine this list with the spatial references for all parent layers. Some WMS services will list inherited spatial references on child layers, so duplicates should be ignored.

To use a specific spatial reference, add the WmsLayer to a Map with the desired SpatialReference prior to loading it.

QStringList WmsLayerInfo::styles() const

Returns a list of supported styles.

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.

QList<WmsLayerInfo> WmsLayerInfo::sublayerInfos() const

Returns the sublayer infos.

QString WmsLayerInfo::title() const

Returns the title.

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

Assignment operator from other WmsLayerInfo.

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

Move operator from other WmsLayerInfo.


Feedback on this topic?