Class: QgsLabelPlacementSettings

class qgis.core.QgsLabelPlacementSettings

Bases: sip.wrapper

Contains general settings related to how labels are placed.

New in version 3.26:

Methods

allowDegradedPlacement

Returns True if labels can be placed in inferior fallback positions if they cannot otherwise be placed.

overlapHandling

Returns the technique used to handle overlapping labels.

setAllowDegradedPlacement

Sets whether labels can be placed in inferior fallback positions if they cannot otherwise be placed.

setOverlapHandling

Sets the technique used to handle overlapping labels.

updateDataDefinedProperties

Updates the placement settings to respect any data defined properties set within the specified properties collection.

allowDegradedPlacement(self) bool

Returns True if labels can be placed in inferior fallback positions if they cannot otherwise be placed.

For instance, this will permit a curved line label to fallback to a horizontal label at the end of the line if the label cannot otherwise be placed on the line in a curved manner.

Return type

bool

overlapHandling(self) Qgis.LabelOverlapHandling

Returns the technique used to handle overlapping labels.

Return type

Qgis.LabelOverlapHandling

setAllowDegradedPlacement(self, allow: bool)

Sets whether labels can be placed in inferior fallback positions if they cannot otherwise be placed.

For instance, this will permit a curved line label to fallback to a horizontal label at the end of the line if the label cannot otherwise be placed on the line in a curved manner.

Parameters

allow (bool) –

setOverlapHandling(self, handling: Qgis.LabelOverlapHandling)

Sets the technique used to handle overlapping labels.

Parameters

handling (Qgis.LabelOverlapHandling) –

updateDataDefinedProperties(self, properties: QgsPropertyCollection, context: QgsExpressionContext)

Updates the placement settings to respect any data defined properties set within the specified properties collection.

Parameters