Class: QgsMapLayerServerProperties

Manages QGIS Server properties for a map layer.

Added in version 3.10.

Class Hierarchy

Base classes

QgsServerMetadataUrlProperties	Manages QGIS Server properties for a map layer.
QgsServerWmsDimensionProperties	Manages QGIS Server properties for WMS dimensions.

Subclasses

QgsVectorLayerServerProperties

Convenient class for API compatibility.

class qgis.core.QgsMapLayerServerProperties

Bases: QgsServerMetadataUrlProperties, QgsServerWmsDimensionProperties

__init__(layer: QgsMapLayer | None = None)

Constructor - Creates a Map Layer QGIS Server Properties

Parameters:

layer (Optional[QgsMapLayer] = None) – The map layer

__init__(a0: QgsMapLayerServerProperties)

Parameters:

a0 (QgsMapLayerServerProperties)

abstract(self) → str

Returns the abstract of the layerused by QGIS Server in GetCapabilities request.

See also

setAbstract()

Added in version 3.38.

Return type:

str

attribution(self) → str

Returns the attribution of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

See also

setAttribution()

Added in version 3.38.

Return type:

str

attributionUrl(self) → str

Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

See also

setAttributionUrl()

Added in version 3.38.

Return type:

str

copyTo(self, properties: QgsMapLayerServerProperties | None)

Copy properties to another instance

Parameters:

properties (Optional[QgsMapLayerServerProperties]) – The properties to copy to

dataUrl(self) → str

Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.

DataUrl is a a link to the underlying data represented by a particular layer.

See also

setDataUrl()

Added in version 3.38.

Return type:

str

dataUrlFormat(self) → str

Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.

DataUrl is a a link to the underlying data represented by a particular layer.

See also

setDataUrlFormat()

Added in version 3.38.

Return type:

str

keywordList(self) → str

Returns the keyword list of the layerused by QGIS Server in GetCapabilities request.

See also

setKeywordList()

Added in version 3.38.

Return type:

str

legendUrl(self) → str

Returns the URL for the layer’s legend.

Added in version 3.44.

Return type:

str

legendUrlFormat(self) → str

Returns the format for a URL based layer legend.

Added in version 3.44.

Return type:

str

readXml(self, layer_node: QDomNode)

Reads server properties from project file.

Added in version 3.10.

Parameters:

layer_node (QDomNode)

reset(self)

Reset properties to default

Added in version 3.22.

setAbstract(self, abstract: str | None)

Sets the abstract of the layer used by QGIS Server in GetCapabilities request.

See also

abstract()

Added in version 3.38.

Parameters:

abstract (Optional[str])

setAttribution(self, attrib: str | None)

Sets the attribution of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

See also

attribution()

Added in version 3.38.

Parameters:

attrib (Optional[str])

setAttributionUrl(self, url: str | None)

Sets the attribution url of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

See also

attributionUrl()

Added in version 3.38.

Parameters:

url (Optional[str])

setDataUrl(self, dataUrl: str | None)

Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.

DataUrl is a a link to the underlying data represented by a particular layer.

See also

dataUrl()

Added in version 3.38.

Parameters:

dataUrl (Optional[str])

setDataUrlFormat(self, dataUrlFormat: str | None)

Sets the DataUrl format of the layerused by QGIS Server in GetCapabilities request.

DataUrl is a a link to the underlying data represented by a particular layer.

See also

dataUrlFormat()

Added in version 3.38.

Parameters:

dataUrlFormat (Optional[str])

setKeywordList(self, keywords: str | None)

Sets the keywords list of the layerused by QGIS Server in GetCapabilities request.

See also

keywordList()

Added in version 3.38.

Parameters:

keywords (Optional[str])

setLegendUrl(self, legendUrl: str | None)

Sets the URL for the layer’s legend.

Added in version 3.44.

Parameters:

legendUrl (Optional[str])

setLegendUrlFormat(self, legendUrlFormat: str | None)

Sets the format for a URL based layer legend.

Added in version 3.44.

Parameters:

legendUrlFormat (Optional[str])

setShortName(self, name: str | None)

Sets the short name of the layer used by QGIS Server to identify the layer.

See also

shortName()

Added in version 3.38.

Parameters:

name (Optional[str])

setTitle(self, title: str | None)

Sets the title of the layer used by QGIS Server in GetCapabilities request.

See also

title()

Added in version 3.38.

Parameters:

title (Optional[str])

setWfsTitle(self, title: str | None)

Sets the title of the layer used by QGIS Server in WFS GetCapabilities request.

See also

title()

Added in version 3.40.

Parameters:

title (Optional[str])

shortName(self) → str

Returns the short name of the layer used by QGIS Server to identify the layer.

See also

setShortName()

Added in version 3.38.

Return type:

str

title(self) → str

Returns the title of the layer used by QGIS Server in GetCapabilities request.

See also

setTitle()

Added in version 3.38.

Return type:

str

wfsTitle(self) → str

Returns the optional WFS title if set or the title of the layer used by QGIS WFS in GetCapabilities request.

See also

setWfsTitle()

Added in version 3.40.

Return type:

str

wfsTypeName(self) → str

Returns WFS typename for the layer

Added in version 4.0.0.

Return type:

str

writeXml(self, layer_node: QDomNode, document: QDomDocument)

Saves server properties to xml under the layer node

Added in version 3.10.

Parameters:

• layer_node (QDomNode)

• document (QDomDocument)