Class: QgsLabelPlacementSettings

Contains general settings related to how labels are placed.

Added in version 3.26.

class qgis.core.QgsLabelPlacementSettings[source]

Bases: object

allowDegradedPlacement(self) bool[source]

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[source]

Returns the technique used to handle overlapping labels.

Return type:

Qgis.LabelOverlapHandling

prioritization(self) Qgis.LabelPrioritization[source]

Returns the label prioritization technique.

Added in version 3.38.

Return type:

Qgis.LabelPrioritization

setAllowDegradedPlacement(self, allow: bool)[source]

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)[source]

Sets the technique used to handle overlapping labels.

Parameters:

handling (Qgis.LabelOverlapHandling)

setPrioritization(self, prioritization: Qgis.LabelPrioritization)[source]

Sets the technique used to prioritize labels.

See also

prioritization()

Added in version 3.38.

Parameters:

prioritization (Qgis.LabelPrioritization)

updateDataDefinedProperties(self, properties: QgsPropertyCollection, context: QgsExpressionContext)[source]

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

Parameters: