Class: QgsGroupWmsDataDialog

A dialog for configuring a WMS group.

List of all members, including inherited members

Class Hierarchy

Base classes

QDialog
QWidget
QObject
QPaintDevice

Constructor

__init__

Methods

groupAbstract	Returns group WMS abstract
groupRequestMode	Returns the request mode of the group.
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
setGroupRequestMode	Sets the request mode of the group.
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

Bases: QDialog

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

Constructor

Parameters:

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

• fl (Qt.WindowType = QgsGuiUtils.ModalDialogFlags) – dialog window flags

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

Constructor

Parameters:

• serverProperties (QgsMapLayerServerProperties) – used to initialize the dialog

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

• fl (Qt.WindowType = QgsGuiUtils.ModalDialogFlags) – dialog window flags

groupAbstract(self) → str

Returns group WMS abstract

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

Return type:

str

groupRequestMode(self) → Qgis.WmsGroupRequestMode

Returns the request mode of the group. When it’s opaque, WMS treats it as a single opaque layer instead of a collection of individual layers. Its child layers are hidden from GetCapabilities requests. Any direct requests (like GetMap or GetFeatureInfo etc.) for a child layer will result in an error. Child layers are rendered whenever a request is made for the group itself.

See also

setGroupRequestMode()

See also

QgsLayerTreeGroup.setWmsGroupRequestMode()

Added in version 4.2.

Return type:

Qgis.WmsGroupRequestMode

groupShortName(self) → str

Returns group WMS short name

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

Return type:

str

groupTitle(self) → str

Returns group WMS title

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

Return type:

str

hasTimeDimension(self) → bool

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.

See also

setHasTimeDimension()

Added in version 3.44.

Return type:

bool

serverProperties(self) → QgsMapLayerServerProperties | None

Returns QGIS Server Properties for the layer tree group

Added in version 3.44.

Return type:

Optional[QgsMapLayerServerProperties]

setGroupAbstract(self, abstract: str | None)

Sets group WMS abstract

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

Parameters:

abstract (Optional[str])

setGroupRequestMode(self, groupRequestMode: Qgis.WmsGroupRequestMode)

Sets the request mode of the group.

Parameters:

groupRequestMode (Qgis.WmsGroupRequestMode) – On Opaque, WMS treats it as a single opaque layer instead of a collection of individual layers. On Normal it behaves as a standard group.

See also

groupRequestMode()

See also

QgsLayerTreeGroup.wmsGroupRequestMode()

Added in version 4.2.

setGroupShortName(self, shortName: str | None)

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)

Sets group WMS title

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

Parameters:

title (Optional[str])

setHasTimeDimension(self, hasTimeDimension: bool)

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.

See also

hasTimeDimension()

Added in version 3.44.