Class: QgsLayerPropertiesWidget

A widget which allows configuration of the properties of a single QgsSymbolLayer.

This widget includes a combobox box for selection of the symbol layer type, and a panel for showing configuration properties for the selected symbol layer type.

QgsLayerPropertiesWidget showing a simple fill symbol layer

Class Hierarchy

Base classes

QgsPanelWidget	Base class for any widget that can be shown as an inline panel.
QWidget
QObject
QPaintDevice
QgsExpressionContextGenerator	Abstract interface for generating an expression context.

class qgis.gui.QgsLayerPropertiesWidget

Bases: QgsPanelWidget, QgsExpressionContextGenerator

__init__(layer: QgsSymbolLayer | None, symbol: QgsSymbol | None, vl: QgsVectorLayer | None, parent: QWidget | None = None)

Constructor for QgsLayerPropertiesWidget.

Parameters:

• layer (Optional[QgsSymbolLayer]) – the symbol layer

• symbol (Optional[QgsSymbol]) – the symbol

• vl (Optional[QgsVectorLayer]) – associated vector layer

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

signal changeLayer

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal changed

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

context(self) → QgsSymbolWidgetContext

Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.

See also

setContext()

Return type:

QgsSymbolWidgetContext

emitSignalChanged(self)

layerTypeChanged(self)

populateLayerTypes(self)

registerDataDefinedButton(self, button: QgsPropertyOverrideButton | None, key: QgsSymbolLayer.Property)

Registers a data defined override button. Handles setting up connections for the button and initializing the button to show the correct descriptions and help text for the associated property.

Parameters:

• button (Optional[QgsPropertyOverrideButton])

• key (QgsSymbolLayer.Property)

setContext(self, context: QgsSymbolWidgetContext)

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

Parameters:

context (QgsSymbolWidgetContext) – symbol widget context

See also

context()

updateSymbolLayerWidget(self, layer: QgsSymbolLayer | None)

Parameters:

layer (Optional[QgsSymbolLayer])