Class: QgsLabelPlacementSettings¶

class qgis.core.QgsLabelPlacementSettings¶

Bases: sip.wrapper

Contains general settings related to how labels are placed.

Added 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.
`prioritization`	Returns the label prioritization technique.
`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.
`setPrioritization`	Sets the technique used to prioritize 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.

See also

setAllowDegradedPlacement()

Return type:: bool

overlapHandling(self) → Qgis.LabelOverlapHandling¶

Returns the technique used to handle overlapping labels.

See also

setOverlapHandling()

Return type:: Qgis.LabelOverlapHandling

prioritization(self) → Qgis.LabelPrioritization¶

Returns the label prioritization technique.

See also

setPrioritization()

Added in version 3.38.

Return type:: Qgis.LabelPrioritization

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.

See also

allowDegradedPlacement()