Class: QgsMapLayerServerProperties¶
- class qgis.core.QgsMapLayerServerProperties¶
Bases:
QgsServerMetadataUrlProperties
,QgsServerWmsDimensionProperties
Manages QGIS Server properties for a map layer
Added in version 3.10.
QgsMapLayerServerProperties(layer:
QgsMapLayer
= None) Constructor - Creates a Map Layer QGIS Server Properties- Parameters:
layer – The map layer
QgsMapLayerServerProperties(
QgsMapLayerServerProperties
)Methods
Returns the abstract of the layerused by QGIS Server in GetCapabilities request.
Returns the attribution of the layer used by QGIS Server in GetCapabilities request.
Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.
Copy properties to another instance
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
Returns the keyword list of the layerused by QGIS Server in GetCapabilities request.
Gets the parent layer
Reads server properties from project file.
Reset properties to default
Sets the
abstract
of the layer used by QGIS Server in GetCapabilities request.Sets the
attribution
of the layer used by QGIS Server in GetCapabilities request.Sets the attribution
url
of the layer used by QGIS Server in GetCapabilities request.Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.
Sets the DataUrl
format
of the layerused by QGIS Server in GetCapabilities request.Sets the
keywords
list of the layerused by QGIS Server in GetCapabilities request.Sets the short
name
of the layer used by QGIS Server to identify the layer.Sets the
title
of the layer used by QGIS Server in GetCapabilities request.Returns the short name of the layer used by QGIS Server to identify the layer.
Returns the title of the layer used by QGIS Server in GetCapabilities request.
Saves server properties to xml under the layer node
Attributes
- abstract(self) str ¶
Returns the abstract of the layerused by QGIS Server in GetCapabilities request.
See also
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
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
Added in version 3.38.
- Return type:
str
- copyTo(self, properties: QgsMapLayerServerProperties)¶
Copy properties to another instance
- Parameters:
properties (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
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
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
Added in version 3.38.
- Return type:
str
- layer(self) QgsMapLayer ¶
Gets the parent layer
- Return type:
- 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)¶
Sets the
abstract
of the layer used by QGIS Server in GetCapabilities request.See also
Added in version 3.38.
- Parameters:
abstract (str)
- setAttribution(self, attrib: str)¶
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
Added in version 3.38.
- Parameters:
attrib (str)
- setAttributionUrl(self, url: str)¶
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
Added in version 3.38.
- Parameters:
url (str)
- setDataUrl(self, dataUrl: str)¶
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
Added in version 3.38.
- Parameters:
dataUrl (str)
- setDataUrlFormat(self, dataUrlFormat: str)¶
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
Added in version 3.38.
- Parameters:
dataUrlFormat (str)
- setKeywordList(self, keywords: str)¶
Sets the
keywords
list of the layerused by QGIS Server in GetCapabilities request.See also
Added in version 3.38.
- Parameters:
keywords (str)
- setShortName(self, name: str)¶
Sets the short
name
of the layer used by QGIS Server to identify the layer.See also
Added in version 3.38.
- Parameters:
name (str)
- setTitle(self, title: str)¶
Sets the
title
of the layer used by QGIS Server in GetCapabilities request.See also
Added in version 3.38.
- Parameters:
title (str)
- shortName(self) str ¶
Returns the short name of the layer used by QGIS Server to identify the layer.
See also
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
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)