Class: QgsStackedDiagramRenderer

Renders diagrams using mixed diagram render types.

The size of the rendered diagram is given by a combination of subrenderers.

Added in version 3.40.

List of all members, including inherited members

Class Hierarchy

Base classes

QgsDiagramRenderer

Evaluates and returns the diagram settings relating to a diagram for a specific feature.

Abstract Methods

diagramSettings

Returns list with all diagram settings in the renderer

Methods

addRenderer	Adds a renderer to the stacked renderer object.
renderer	Returns the renderer at the given index.
rendererCount	Returns the number of sub renderers in the stacked diagram renderer
renderers	Returns an ordered list with the renderers of the stacked renderer object.
setDiagramSettings

Virtual Methods

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

renderDiagram

Renders the diagram for a specified feature at a specific position in the passed render context, taking all renderers and their own diagrams into account.

class qgis.core.QgsStackedDiagramRenderer

Bases: QgsDiagramRenderer

addRenderer(self, renderer: QgsDiagramRenderer | None)

Adds a renderer to the stacked renderer object. Takes ownership.

Renderers added first will render their diagrams first, i.e., more to the left (horizontal mode) or more to the top (vertical mode).

Parameters:

renderer (Optional[QgsDiagramRenderer]) – diagram renderer to be added to the stacked renderer

abstract diagramSettings(self) → list[QgsDiagramSettings]

Returns list with all diagram settings in the renderer

diagramSettings(self, feature: QgsFeature, c: QgsRenderContext, s: QgsDiagramSettings) -> bool

Return type:

list[QgsDiagramSettings]

virtual renderDiagram(self, feature: QgsFeature, c: QgsRenderContext, pos: QPointF, properties: QgsPropertyCollection = QgsPropertyCollection())

Renders the diagram for a specified feature at a specific position in the passed render context, taking all renderers and their own diagrams into account. Diagram rendering is delegated to renderer’s diagram.

Parameters:

• feature (QgsFeature)

• c (QgsRenderContext)

• pos (QPointF)

• properties (QgsPropertyCollection = QgsPropertyCollection())

renderer(self, index: int) → QgsDiagramRenderer | None

Returns the renderer at the given index. Does not transfer ownership.

Parameters:

index (int) – index of the desired renderer in the stacked renderer

Return type:

Optional[QgsDiagramRenderer]

rendererCount(self) → int

Returns the number of sub renderers in the stacked diagram renderer

Return type:

int

renderers(self, sortByDiagramMode: bool = False) → list[QgsDiagramRenderer]

Returns an ordered list with the renderers of the stacked renderer object. Does not transfer ownership.

Parameters:

sortByDiagramMode (bool = False) – If true, the list is returned backwards for vertical orientation.

Return type:

list[QgsDiagramRenderer]

setDiagramSettings(self, s: QgsDiagramSettings)

Parameters:

s (QgsDiagramSettings)