Class: QgsDataDefinedSizeLegend¶

Object that keeps configuration of appearance of marker symbol’s data-defined size in legend.

For example: the list of classes (size values), whether the classes should appear in separate legend nodes or whether to collapse them into one legend node.

class qgis.core.QgsDataDefinedSizeLegend[source]¶

Bases: object

__init__(): Constructor for QgsDataDefinedSizeLegend.

__init__(other: QgsDataDefinedSizeLegend)

Parameters:: other (QgsDataDefinedSizeLegend)

AlignBottom = 1¶

AlignCenter = 0¶

LegendCollapsed = 1¶

LegendSeparated = 0¶

class LegendType¶: Bases: int

class SizeClass¶

Bases: object

Definition of one class for the legend

label: str¶

size: float¶

class VerticalAlignment¶: Bases: int

classes(self) → List[QgsDataDefinedSizeLegend.SizeClass]¶

Returns list of classes: each class is a pair of symbol size (in units used by the symbol) and label

Return type:: List[QgsDataDefinedSizeLegend.SizeClass]

collapsedLegendImage(self, context: QgsRenderContext, backgroundColor: QColor | Qt.GlobalColor = Qt.transparent, paddingMM: float = 1) → QImage[source]¶

Returns output image that would be shown in the legend. Returns invalid image if legend is not configured as collapsed.

Parameters:

context (QgsRenderContext)
backgroundColor (Union[QColor, Qt.GlobalColor] = Qt.transparent)
paddingMM (float = 1)

Return type:

QImage

drawCollapsedLegend(self, context: QgsRenderContext)[source]¶

Draw the legend if using LegendOneNodeForAll and optionally output size of the legend and x offset of labels (in painter units). If the painter in context is None, it only does size calculation without actual rendering. Does nothing if legend is not configured as collapsed.