Class: QgsLabelingResults¶

Class that stores computed placement from labeling engine.

Methods

`allLabels`	Returns a list of all labels generated by the labeling run.
`calloutsWithinRectangle`	Returns a list of callouts with origins or destinations inside the given rectangle.
`groupedLabelPositions`	Returns a list of all label positions sharing the same group ID (i.e. positions for individual characters in a curved label).
`labelsAtPosition`	Returns the details of any labels placed at the specified point (in map coordinates).
`labelsWithinRect`	Returns the details of any labels placed within the specified rectangle (in map coordinates).
`setMapSettings`	Sets the map settings associated with the labeling run.

class qgis.core.QgsLabelingResults[source]¶

Bases: object

allLabels(self) → List[QgsLabelPosition]¶

Returns a list of all labels generated by the labeling run.

Added in version 3.20.

calloutsWithinRectangle(self, rectangle: QgsRectangle) → List[QgsCalloutPosition]¶

Returns a list of callouts with origins or destinations inside the given rectangle.

The rectangle is specified in map coordinates.

Added in version 3.20.

groupedLabelPositions(self, groupId: int) → List[QgsLabelPosition]¶

Returns a list of all label positions sharing the same group ID (i.e. positions for individual characters in a curved label).

Added in version 3.26.

labelsAtPosition(self, p: QgsPointXY) → List[QgsLabelPosition]¶

Returns the details of any labels placed at the specified point (in map coordinates).

labelsWithinRect(self, r: QgsRectangle) → List[QgsLabelPosition]¶

Returns the details of any labels placed within the specified rectangle (in map coordinates).

setMapSettings(self, settings: QgsMapSettings)[source]¶

Sets the map settings associated with the labeling run.

Added in version 3.4.8.