Class: QgsServerWmsDimensionProperties

class qgis.core.QgsServerWmsDimensionProperties

Bases: sip.wrapper

Manages QGIS Server properties for Wms dimensions

New in version 3.22:

Methods

addWmsDimension

Adds a QGIS Server WMS Dimension

layer

Gets the parent layer

removeWmsDimension

Removes a QGIS Server WMS Dimension

setWmsDimensions

Set WMS Dimensions

wmsDimensionDefaultDisplayLabels

Returns WMS Dimension default display labels

wmsDimensions

Returns the QGIS Server WMS Dimension list.

Attributes

DATE

ELEVATION

TIME

staticMetaObject

DATE = 1
ELEVATION = 2
class PredefinedWmsDimensionName

Bases: int

baseClass

alias of qgis._core.QgsServerWmsDimensionProperties

TIME = 0
class WmsDimensionInfo(dimName: str, dimFieldName: str, dimEndFieldName: str = '', dimUnits: str = '', dimUnitSymbol: str = '', dimDefaultDisplayType: int = QgsServerWmsDimensionProperties.WmsDimensionInfo.AllValues, dimReferenceValue: Any = None)

Bases: sip.wrapper

Constructor for WmsDimensionInfo.

QgsServerWmsDimensionProperties.WmsDimensionInfo(QgsServerWmsDimensionProperties.WmsDimensionInfo)

AllValues = 0
class DefaultDisplay

Bases: int

MaxValue = 2
MinValue = 1
ReferenceValue = 3
defaultDisplayType
endFieldName
fieldName
name
referenceValue
unitSymbol
units
addWmsDimension(self, wmsDimInfo: QgsServerWmsDimensionProperties.WmsDimensionInfo) bool

Adds a QGIS Server WMS Dimension

Parameters

wmsDimInfo (QgsServerWmsDimensionProperties.WmsDimensionInfo) – QGIS Server WMS Dimension object with, name, field, etc

Return type

bool

Returns

True if QGIS Server WMS Dimension has been successfully added

New in version 3.10.

layer(self) QgsMapLayer

Gets the parent layer

Return type

QgsMapLayer

removeWmsDimension(self, wmsDimName: str) bool

Removes a QGIS Server WMS Dimension

Return type

bool

Returns

True if QGIS Server WMS Dimension was found and successfully removed

New in version 3.10.

Parameters

wmsDimName (str) –

setWmsDimensions(self, dimensions: Iterable[QgsServerWmsDimensionProperties.WmsDimensionInfo])

Set WMS Dimensions

Parameters

dimensions (Iterable[QgsServerWmsDimensionProperties.WmsDimensionInfo]) – the new dimensions that replace the current ones.

staticMetaObject = <PyQt5.QtCore.QMetaObject object>
wmsDimensionDefaultDisplayLabels() Dict[int, str]

Returns WMS Dimension default display labels

New in version 3.10.

Return type

Dict[int, str]

wmsDimensions(self) List[QgsServerWmsDimensionProperties.WmsDimensionInfo]

Returns the QGIS Server WMS Dimension list.

New in version 3.10.

Return type

List[QgsServerWmsDimensionProperties.WmsDimensionInfo]