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.

Methods

`classes`	Returns list of classes: each class is a pair of symbol size (in units used by the symbol) and label
`collapsedLegendImage`	Returns output image that would be shown in the legend.
`drawCollapsedLegend`	Draw the legend if using LegendOneNodeForAll and optionally output size of the legend and x offset of labels (in painter units).
`font`	Returns font used for rendering of labels - only valid for collapsed legend
`legendSymbolList`	Generates legend symbol items according to the configuration
`legendType`	Returns how the legend should be rendered
`lineSymbol`	Returns the line symbol that will be used to draw callout lines in legend.
`setClasses`	Sets list of classes: each class is a pair of symbol size (in units used by the symbol) and label
`setFont`	Sets font used for rendering of labels - only valid for collapsed legend
`setLegendType`	Sets how the legend should be rendered
`setLineSymbol`	Sets the line symbol that will be used to draw callout lines in legend.
`setSizeScaleTransformer`	Sets transformer for scaling of symbol sizes.
`setSymbol`	Sets marker symbol that will be used to draw markers in legend
`setTextAlignment`	Sets horizontal text alignment for rendering of labels - only valid for collapsed legend
`setTextColor`	Sets text color for rendering of labels - only valid for collapsed legend
`setTitle`	Sets title label for data-defined size legend
`setVerticalAlignment`	Sets vertical alignment of symbols - only valid for collapsed legend
`sizeScaleTransformer`	Returns transformer for scaling of symbol sizes.
`symbol`	Returns marker symbol that will be used to draw markers in legend
`textAlignment`	Returns horizontal text alignment for rendering of labels - only valid for collapsed legend
`textColor`	Returns text color for rendering of labels - only valid for collapsed legend
`title`	Returns title label for data-defined size legend
`updateFromSymbolAndProperty`	Updates the list of classes, source symbol and title label from given symbol and property
`verticalAlignment`	Returns vertical alignment of symbols - only valid for collapsed legend
`writeXml`	Writes configuration to the given XML element.

Static Methods

readXml

Creates instance from given element and returns it (caller takes ownership).

Attributes

`AlignBottom`
`AlignCenter`
`LegendCollapsed`
`LegendSeparated`

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¶: Label to be shown with the particular symbol size

size¶: Marker size in units used by the symbol (usually millimeters). May be further scaled before rendering if size scale transformer is enabled.

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.

Parameters:: context (QgsRenderContext) -> (Optional[QSizeF])

font(self) → QFont[source]¶

Returns font used for rendering of labels - only valid for collapsed legend

Return type:: QFont

legendSymbolList(self) → List[QgsLegendSymbolItem][source]¶

Generates legend symbol items according to the configuration

Return type:: List[QgsLegendSymbolItem]

legendType(self) → QgsDataDefinedSizeLegend.LegendType[source]¶

Returns how the legend should be rendered

Return type:: QgsDataDefinedSizeLegend.LegendType

lineSymbol(self) → QgsLineSymbol | None[source]¶

Returns the line symbol that will be used to draw callout lines in legend.