Class: QgsMapLayerServerProperties

class qgis.core.QgsMapLayerServerProperties

Bases: QgsServerMetadataUrlProperties, QgsServerWmsDimensionProperties

Manages QGIS Server properties for a map layer

Added in version 3.10.

QgsMapLayerServerProperties(layer: Optional[QgsMapLayer] = None) Constructor - Creates a Map Layer QGIS Server Properties

Parameters:

layer – The map layer

QgsMapLayerServerProperties(a0: QgsMapLayerServerProperties)

Methods

abstract

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

attribution

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

attributionUrl

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

copyTo

Copy properties to another instance

dataUrl

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

dataUrlFormat

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

keywordList

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

layer

Gets the parent layer

readXml

Reads server properties from project file.

reset

Reset properties to default

setAbstract

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

setAttribution

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

setAttributionUrl

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

setDataUrl

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

setDataUrlFormat

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

setKeywordList

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

setShortName

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

setTitle

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

shortName

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

title

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

writeXml

Saves server properties to xml under the layer node

Attributes

staticMetaObject

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.

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.

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

layer(self) QgsMapLayer | None

Gets the parent layer

Return type:

Optional[QgsMapLayer]

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

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

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

staticMetaObject = <PyQt5.QtCore.QMetaObject object>
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

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)