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¶

`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.

`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`.

Abstract Methods

Returns pointer to the renderer (no transfer of ownership)

Methods

`applyChanges`	This method should be called whenever the renderer is actually set on the layer.
`changeSymbolAngle`	Change marker angles of selected symbols
`changeSymbolColor`	Change color of selected symbols
`changeSymbolOpacity`	Change opacity of selected symbols
`changeSymbolSize`	Change marker sizes of selected symbols
`changeSymbolUnit`	Change units mm/map units of selected symbols
`changeSymbolWidth`	Change line widths of selected symbols
`context`	Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.
`contextMenuViewCategories`
`createDataDefinedSizeLegendWidget`	Creates widget to setup data-defined size legend.
`registerDataDefinedButton`	Registers a data defined override button.
`showSymbolLevelsDialog`	Show a dialog with renderer's symbol level settings.
`vectorLayer`	Returns the vector layer associated with the widget.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsRendererWidget. See the FAQ for more details.

`apply`
`copy`
`paste`
`pasteSymbolToSelection`	Pastes the clipboard symbol over selected items.
`refreshSymbolView`
`selectedSymbols`	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&).
`setContext`	Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts.
`setSymbolLevels`	Sets the symbol levels for the renderer defined in the widget.

Signals

`layerVariablesChanged`	Emitted when expression context variables on the associated vector layers have been changed.
`symbolLevelsChanged`	Emitted when the symbol levels settings have been changed.

class qgis.gui.QgsRendererWidget[source]¶

Bases: QgsPanelWidget, QgsExpressionContextGenerator

applyChanges(self)[source]¶: This method should be called whenever the renderer is actually set on the layer.

changeSymbolAngle(self)[source]¶: Change marker angles of selected symbols

changeSymbolUnit(self)[source]¶: Change units mm/map units of selected symbols

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