Class: QgsLabelThinningSettings

Contains settings related to how the label engine removes candidate label positions and reduces the number of displayed labels.

Added in version 3.12.

class qgis.core.QgsLabelThinningSettings

Bases: object

allowDuplicateRemoval(self) → bool

Returns whether duplicate label removal is permitted for this layer.

See also

setAllowDuplicateRemoval()

Added in version 3.44.

Return type:

bool

labelMarginDistance(self) → float

Returns the minimum distance to other labels (i.e. the minimum space/margin around labels).

Units are specified through labelMarginDistanceUnit().

See also

setLabelMarginDistance()

See also

labelMarginDistanceUnit()

Added in version 3.44.

Return type:

float

labelMarginDistanceMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the minimum distance to other labels.

See also

setLabelMarginDistanceMapUnitScale()

See also

labelMarginDistanceUnit()

See also

labelMarginDistance()

Added in version 3.44.

Return type:

QgsMapUnitScale

labelMarginDistanceUnit(self) → Qgis.RenderUnit

Returns the units for the minimum distance to other labels.

See also

setLabelMarginDistanceUnit()

See also

labelMarginDistance()

Added in version 3.44.

Return type:

Qgis.RenderUnit

limitNumberOfLabelsEnabled(self) → bool

Returns True if the number of labels drawn for the layer should be limited.

See also

maximumNumberLabels()

See also

setLimitNumberLabelsEnabled()

Return type:

bool

maximumNumberLabels(self) → int

Returns the maximum number of labels which should be drawn for this layer. This only has an effect if limitNumberOfLabelsEnabled() is True.

See also

limitNumberOfLabelsEnabled()

See also

setMaximumNumberLabels()

Return type:

int

minimumDistanceToDuplicate(self) → float

Returns the minimum distance to labels with duplicate text.

Units are specified through minimumDistanceToDuplicateUnit().

Note

This setting is only respected if allowDuplicateRemoval() is True.

See also

setMinimumDistanceToDuplicate()

See also

minimumDistanceToDuplicateUnit()

Added in version 3.44.

Return type:

float

minimumDistanceToDuplicateMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the minimum distance to labels with duplicate text.

Note

This setting is only respected if allowDuplicateRemoval() is True.

See also

setMinimumDistanceToDuplicateMapUnitScale()

See also

minimumDistanceToDuplicateUnit()

See also

minimumDistanceToDuplicate()

Added in version 3.44.

Return type:

QgsMapUnitScale

minimumDistanceToDuplicateUnit(self) → Qgis.RenderUnit

Returns the units for the minimum distance to labels with duplicate text.

Note

This setting is only respected if allowDuplicateRemoval() is True.

See also

setMinimumDistanceToDuplicateUnit()

See also

minimumDistanceToDuplicate()

Added in version 3.44.

Return type:

Qgis.RenderUnit

minimumFeatureSize(self) → float

Returns the minimum feature size (in millimeters) for a feature to be labelled.

See also

setMinimumFeatureSize()

Return type:

float

setAllowDuplicateRemoval(self, allow: bool)

Sets whether duplicate label removal is permitted for this layer.

See also

setAllowDuplicateRemoval()

Added in version 3.44.

Parameters:

allow (bool)

setLabelMarginDistance(self, distance: float)

Sets the minimum distance to other labels (i.e. the minimum space/margin around labels).

Units are specified through setLabelMarginDistanceUnit().

See also

labelMarginDistance()

See also

setLabelMarginDistanceUnit()

Added in version 3.44.

Parameters:

distance (float)

setLabelMarginDistanceMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the minimum distance to other labels.

See also

labelMarginDistanceMapUnitScale()

See also

labelMarginDistanceUnit()

See also

setLabelMarginDistance()

Added in version 3.44.

Parameters:

scale (QgsMapUnitScale)

setLabelMarginDistanceUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the minimum distance to other labels.

See also

labelMarginDistanceUnit()

See also

setLabelMarginDistance()

Added in version 3.44.

Parameters:

unit (Qgis.RenderUnit)

setLimitNumberLabelsEnabled(self, enabled: bool)

Sets whether the the number of labels drawn for the layer should be limited.

See also

setMaximumNumberLabels()

See also

limitNumberOfLabelsEnabled()

Parameters:

enabled (bool)

setMaximumNumberLabels(self, number: int)

Sets the maximum number of labels which should be drawn for this layer. This only has an effect if limitNumberOfLabelsEnabled() is True.

See also

setLimitNumberLabelsEnabled()

See also

maximumNumberLabels()

Parameters:

number (int)

setMinimumDistanceToDuplicate(self, distance: float)

Sets the minimum distance to labels with duplicate text.

Units are specified through setMinimumDistanceToDuplicateUnit().

Note

This setting is only respected if allowDuplicateRemoval() is True.

See also

minimumDistanceToDuplicate()

See also

setMinimumDistanceToDuplicateUnit()

Added in version 3.44.

Parameters:

distance (float)

setMinimumDistanceToDuplicateMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the minimum distance to labels with duplicate text.

Note

This setting is only respected if allowDuplicateRemoval() is True.

See also

minimumDistanceToDuplicateMapUnitScale()

See also

minimumDistanceToDuplicateUnit()

See also

setMinimumDistanceToDuplicate()

Added in version 3.44.

Parameters:

scale (QgsMapUnitScale)

setMinimumDistanceToDuplicateUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the minimum distance to labels with duplicate text.

Note

This setting is only respected if allowDuplicateRemoval() is True.

See also

minimumDistanceToDuplicateUnit()

See also

setMinimumDistanceToDuplicate()

Added in version 3.44.

Parameters:

unit (Qgis.RenderUnit)

setMinimumFeatureSize(self, size: float)

Sets the minimum feature size (in millimeters) for a feature to be labelled.

See also

minimumFeatureSize()

Parameters:

size (float)

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

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

Parameters:

• properties (QgsPropertyCollection)

• context (QgsExpressionContext)