Class: QgsRendererPropertiesDialog

A dialog for configuring vector layer renderers.

QgsRendererPropertiesDialog showing a QgsSingleSymbolRenderer in the default (dialog) mode

QgsRendererPropertiesDialog showing a QgsSingleSymbolRenderer in an embedded widget mode

Class Hierarchy

Base classes

QDialog
QWidget
QObject
QPaintDevice

Methods

apply	Apply the changes from the dialog to the layer.
connectValueChanged	Connect the value changed event for the set of widgets to widgetChanged signal.
onOK	Apply and accept the changes for the dialog.
openPanel	Open a panel or dialog depending on dock mode setting If dock mode is True this method will emit the showPanel signal for connected slots to handle the open event.
rendererChanged	called when user changes renderer type
setContext	Sets the context in which the dialog is shown, e.g., the associated map canvas and expression contexts.
setDockMode	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs
setMapCanvas	Sets the map canvas associated with the dialog.

Signals

layerVariablesChanged	Emitted when expression context variables on the associated vector layers have been changed.
showPanel	Emit when you require a panel to be show in the interface.
widgetChanged	Emitted when something on the widget has changed.

class qgis.gui.QgsRendererPropertiesDialog

Bases: QDialog

__init__(layer: QgsVectorLayer | None, style: QgsStyle | None, embedded: bool = False, parent: QWidget | None = None)

Constructor for QgsRendererPropertiesDialog.

Parameters:

• layer (Optional[QgsVectorLayer]) – associated layer

• style (Optional[QgsStyle]) – style collection

• embedded (bool = False) – set to True to indicate that the dialog will be embedded in another widget, rather than shown as a dialog by itself

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

apply(self)

Apply the changes from the dialog to the layer.

connectValueChanged(self, widgets: Iterable[QWidget])

Connect the value changed event for the set of widgets to widgetChanged signal. Each widget is checked for type and the common type of signal is connected to widgetChanged.

Parameters:

widgets (Iterable[QWidget]) – The list of widgets to check.

signal layerVariablesChanged

Emitted when expression context variables on the associated vector layers have been changed. Will request the parent dialog to re-synchronize with the variables.

onOK(self)

Apply and accept the changes for the dialog.

openPanel(self, panel: QgsPanelWidget | None)

Open a panel or dialog depending on dock mode setting If dock mode is True this method will emit the showPanel signal for connected slots to handle the open event.

If dock mode is False this method will open a dialog and block the user.

Parameters:

panel (Optional[QgsPanelWidget]) – The panel widget to open.

rendererChanged(self)

called when user changes renderer type

setContext(self, context: QgsSymbolWidgetContext)

Sets the context in which the dialog is shown, e.g., the associated map canvas and expression contexts.

Added in version 3.6.

Parameters:

context (QgsSymbolWidgetContext)

setDockMode(self, dockMode: bool)

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs

Parameters:

dockMode (bool) – True to enable dock mode.

setMapCanvas(self, canvas: QgsMapCanvas | None)

Sets the map canvas associated with the dialog. This allows the widget to retrieve the current map scale and other properties from the canvas.

Parameters:

canvas (Optional[QgsMapCanvas]) – map canvas

signal showPanel(panel: QgsPanelWidget)

Emit when you require a panel to be show in the interface.

Parameters:

panel (QgsPanelWidget) – The panel widget to show.

Note

If you are connected to this signal you should also connect given panels showPanel signal as they can be nested.

signal widgetChanged

Emitted when something on the widget has changed. All widgets will fire this event to notify of an internal change.