Class: QgsGroupWmsDataDialog

A dialog for configuring a WMS group.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsGroupWmsDataDialog

Base classes

QDialog

QWidget

QObject

QPaintDevice

Methods

groupAbstract

Returns group WMS abstract

groupShortName

Returns group WMS short name

groupTitle

Returns group WMS title

hasTimeDimension

Returns whether the time dimension should be computed for this group or not.

serverProperties

Returns QGIS Server Properties for the layer tree group

setGroupAbstract

Sets group WMS abstract

setGroupShortName

Sets group WMS short name

setGroupTitle

Sets group WMS title

setHasTimeDimension

Sets whether the time dimension should be computed for this group or not

class qgis.gui.QgsGroupWmsDataDialog[source]

Bases: QDialog

__init__(parent: QWidget | None = None, fl: Qt.WindowFlags | Qt.WindowType = QgsGuiUtils.ModalDialogFlags)

Constructor

Parameters:
  • parent (Optional[QWidget] = None) – parent widget

  • fl (Union[Qt.WindowFlags, Qt.WindowType] = QgsGuiUtils.ModalDialogFlags) – dialog window flags

__init__(serverProperties: QgsMapLayerServerProperties, parent: QWidget | None = None, fl: Qt.WindowFlags | Qt.WindowType = QgsGuiUtils.ModalDialogFlags)

Constructor

Parameters:
  • serverProperties (QgsMapLayerServerProperties) – used to initialize the dialog

  • parent (Optional[QWidget] = None) – parent widget

  • fl (Union[Qt.WindowFlags, Qt.WindowType] = QgsGuiUtils.ModalDialogFlags) – dialog window flags

groupAbstract(self) str[source]

Returns group WMS abstract

Deprecated since version 3.44: Use serverProperties()->:py:func:~QgsGroupWmsDataDialog.abstract instead.

Return type:

str

groupShortName(self) str[source]

Returns group WMS short name

Deprecated since version 3.44: Use serverProperties()->:py:func:~QgsGroupWmsDataDialog.shortName instead.

Return type:

str

groupTitle(self) str[source]

Returns group WMS title

Deprecated since version 3.44: Use serverProperties()->:py:func:~QgsGroupWmsDataDialog.title instead.

Return type:

str

hasTimeDimension(self) bool[source]

Returns whether the time dimension should be computed for this group or not. if True, when a GetCapabilities request is sent, QGIS server would return a TIME dimension computed as an union of all time dimensions of its children recursively. Else, no TIME dimension will be returned.

Added in version 3.44.

Return type:

bool

serverProperties(self) QgsMapLayerServerProperties | None[source]

Returns QGIS Server Properties for the layer tree group

Added in version 3.44.

Return type:

Optional[QgsMapLayerServerProperties]

setGroupAbstract(self, abstract: str | None)[source]

Sets group WMS abstract

Deprecated since version 3.44: Use serverProperties()->:py:func:~QgsGroupWmsDataDialog.setAbstract instead.

Parameters:

abstract (Optional[str])

setGroupShortName(self, shortName: str | None)[source]

Sets group WMS short name

Deprecated since version 3.44: Use serverProperties()->:py:func:~QgsGroupWmsDataDialog.setShortName instead.

Parameters:

shortName (Optional[str])

setGroupTitle(self, title: str | None)[source]

Sets group WMS title

Deprecated since version 3.44: Use serverProperties()->:py:func:~QgsGroupWmsDataDialog.setTitle instead.

Parameters:

title (Optional[str])

setHasTimeDimension(self, hasTimeDimension: bool)[source]

Sets whether the time dimension should be computed for this group or not

Parameters:

hasTimeDimension (bool) – if True, when a GetCapabilities request is sent, QGIS server would return a TIME dimension computed as an union of all time dimensions of its children recursively. Else, no TIME dimension will be returned.

Added in version 3.44.