Class: QgsLabelingResults

class qgis.core.QgsLabelingResults

Bases: sip.wrapper

Class that stores computed placement from labeling engine.

Methods

labelsAtPosition

Returns infos about labels at a given (map) position

labelsWithinRect

Returns infos about labels within a given (map) rectangle

setMapSettings

Sets the map settings associated with the labeling run.

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

Returns infos about labels at a given (map) position

Parameters

p (QgsPointXY) –

Return type

List[QgsLabelPosition]

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

Returns infos about labels within a given (map) rectangle

Parameters

r (QgsRectangle) –

Return type

List[QgsLabelPosition]

setMapSettings(self, settings: QgsMapSettings)

Sets the map settings associated with the labeling run.

New in version 3.4.8.

Parameters

settings (QgsMapSettings) –