Class: QgsRendererWidget

Base class for renderer settings widgets.

WORKFLOW:

• open renderer dialog with some RENDERER (never null!)

• find out which widget to use

• instantiate it and set in stacked widget

• on any change of renderer type, create some default (dummy?) version and change the stacked widget

• when clicked OK/Apply, get the renderer from active widget and clone it for the layer

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: renderer()

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.

Subclasses

Qgs25DRendererWidget	A widget for configuring a Qgs25DRenderer.
QgsCategorizedSymbolRendererWidget	A widget for configuring a QgsCategorizedSymbolRenderer.
QgsEmbeddedSymbolRendererWidget	A widget for configuring options for a QgsEmbeddedSymbolRenderer.
QgsGraduatedSymbolRendererWidget	A widget for configuring a QgsGraduatedSymbolRenderer.
QgsHeatmapRendererWidget	A widget for configuring a QgsHeatmapRenderer.
QgsInvertedPolygonRendererWidget	A widget for configuring options for a QgsInvertedPolygonRenderer.
QgsMergedFeatureRendererWidget	A widget for configuring options for a QgsMergedFeatureRenderer.
QgsNullSymbolRendererWidget	Blank widget for customizing QgsNullSymbolRenderer.
QgsPointClusterRendererWidget	A widget which allows configuration of the properties for a QgsPointClusterRenderer.
QgsPointDisplacementRendererWidget	A widget for configuring QgsPointDisplacementRenderer.
QgsRuleBasedRendererWidget	A widget for configuring a QgsRuleBasedRenderer.
QgsSingleSymbolRendererWidget	A widget for configuring QgsSingleSymbolRenderer.

class qgis.gui.QgsRendererWidget

Bases: QgsPanelWidget, QgsExpressionContextGenerator

virtual apply()

applyChanges(self)

This method should be called whenever the renderer is actually set on the layer.

changeSymbolAngle(self)

Change marker angles of selected symbols

changeSymbolColor(self)

Change color of selected symbols

changeSymbolOpacity(self)

Change opacity of selected symbols

changeSymbolSize(self)

Change marker sizes of selected symbols

changeSymbolUnit(self)

Change units mm/map units of selected symbols

changeSymbolWidth(self)

Change line widths of selected symbols

context(self) → QgsSymbolWidgetContext

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

See also

setContext()

Return type:

QgsSymbolWidgetContext

contextMenuViewCategories(self, p: QPoint)

Parameters:

p (QPoint)

virtual copy(self)

createDataDefinedSizeLegendWidget(self, symbol: QgsMarkerSymbol | None, ddsLegend: QgsDataDefinedSizeLegend | None) → QgsDataDefinedSizeLegendWidget | None

Creates widget to setup data-defined size legend. Returns newly created panel - may be None if it could not be opened. Ownership is transferred to the caller.

Parameters:

• symbol (Optional[QgsMarkerSymbol])

• ddsLegend (Optional[QgsDataDefinedSizeLegend])

Return type:

Optional[QgsDataDefinedSizeLegendWidget]

signal layerVariablesChanged

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.

virtual paste(self)

virtual pasteSymbolToSelection(self)

Pastes the clipboard symbol over selected items.

Added in version 3.10.

virtual refreshSymbolView(self)

registerDataDefinedButton(self, button: QgsPropertyOverrideButton | None, key: QgsFeatureRenderer.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 (QgsFeatureRenderer.Property)

abstract renderer(self) → QgsFeatureRenderer | None

Returns pointer to the renderer (no transfer of ownership)

Return type:

Optional[QgsFeatureRenderer]

virtual selectedSymbols(self) → List[QgsSymbol]

Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&).

Return type:

List[QgsSymbol]

virtual setContext(self, context: QgsSymbolWidgetContext)

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

Parameters:

context (QgsSymbolWidgetContext) – symbol widget context

See also

context()

virtual setSymbolLevels(self, levels: Iterable[QgsLegendSymbolItem], enabled: bool)

Sets the symbol levels for the renderer defined in the widget.

The levels argument defines the updated list of symbols with rendering passes set.

The enabled arguments specifies if symbol levels should be enabled for the renderer.

Added in version 3.20.

Parameters:

• levels (Iterable[QgsLegendSymbolItem])

• enabled (bool)

showSymbolLevelsDialog(self, r: QgsFeatureRenderer | None)

Show a dialog with renderer’s symbol level settings.

Parameters:

r (Optional[QgsFeatureRenderer])

signal symbolLevelsChanged

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.

vectorLayer(self) → QgsVectorLayer | None

Returns the vector layer associated with the widget.

Return type:

Optional[QgsVectorLayer]