Class: QgsServerWmsDimensionProperties¶

Manages QGIS Server properties for Wms dimensions

Added in version 3.22.

Class Hierarchy¶

Subclasses¶

QgsMapLayerServerProperties

Manages QGIS Server properties for a map layer

Methods

`addWmsDimension`	Adds a QGIS Server WMS Dimension
`layer`	Gets the parent layer
`removeWmsDimension`	Removes a QGIS Server WMS Dimension
`setWmsDimensions`	Set WMS Dimensions
`wmsDimensions`	Returns the QGIS Server WMS Dimension list.

Static Methods

wmsDimensionDefaultDisplayLabels

Returns WMS Dimension default display labels

Attributes

`DATE`
`ELEVATION`
`TIME`

class qgis.core.QgsServerWmsDimensionProperties[source]¶

Bases: object

DATE = 1¶

ELEVATION = 2¶

class PredefinedWmsDimensionName¶: Bases: int

TIME = 0¶

class WmsDimensionInfo¶

Bases: object

Setting to define QGIS Server WMS Dimension.

Added in version 3.10.

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[source]¶

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

Added in version 3.10.

layer(self) → QgsMapLayer | None[source]¶

Gets the parent layer

Return type:: Optional[QgsMapLayer]

removeWmsDimension(self, wmsDimName: str | None) → bool[source]¶

Removes a QGIS Server WMS Dimension

Return type:: bool
Returns:: True if QGIS Server WMS Dimension was found and successfully removed

Added in version 3.10.

Parameters:: wmsDimName (Optional[str])

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

Set WMS Dimensions

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

static wmsDimensionDefaultDisplayLabels() → Dict[int, str]¶

Returns WMS Dimension default display labels

Added in version 3.10.

Return type:: Dict[int, str]

wmsDimensions(self) → List[QgsServerWmsDimensionProperties.WmsDimensionInfo]¶

Returns the QGIS Server WMS Dimension list.

Added in version 3.10.

Return type:: List[QgsServerWmsDimensionProperties.WmsDimensionInfo]