Class: QgsAbstractLabelingEngineRuleDistanceFromFeature¶

Base class for labeling engine rules which prevents labels being placed too close or to far from features from a different layer.

Added in version 3.40.

Class Hierarchy¶

Base classes¶

QgsAbstractLabelingEngineRule

Abstract base class for labeling engine rules.

Subclasses¶

`QgsLabelingEngineRuleMaximumDistanceLabelToFeature`	A labeling engine rule which prevents labels being placed too far from features from a different layer.
`QgsLabelingEngineRuleMinimumDistanceLabelToFeature`	A labeling engine rule which prevents labels being placed too close to features from a different layer.

Methods

`cost`	Returns the penalty cost incurred when the rule is violated.
`distance`	Returns the acceptable distance threshold between labels and the features from the `targetLayer()`.
`distanceUnit`	Returns the units for the distance between labels and the features from the `targetLayer()`.
`distanceUnitScale`	Returns the scaling for the distance between labels and the features from the `targetLayer()`.
`labeledLayer`	Returns the layer providing the labels.
`setCost`	Sets the penalty cost incurred when the rule is violated.
`setDistance`	Sets the acceptable distance threshold between labels and the features from the `targetLayer()`.
`setDistanceUnit`	Sets the unit for the distance between labels and the features from the `targetLayer()`.
`setDistanceUnitScale`	Sets the scale for the distance between labels and the features from the `targetLayer()`.
`setLabeledLayer`	Sets the layer providing the labels.
`setTargetLayer`	Sets the layer providing the features which labels must be distant from (or close to).
`targetLayer`	Returns the layer providing the features which labels must be distant from (or close to).

class qgis.core.QgsAbstractLabelingEngineRuleDistanceFromFeature[source]¶

Bases: QgsAbstractLabelingEngineRule

cost(self) → float[source]¶

Returns the penalty cost incurred when the rule is violated.

This is a value between 0 and 10, where 10 indicates that the rule must never be violated, and 1-9 = nice to have if possible, where higher numbers will try harder to avoid violating the rule.

See also

setCost()

Return type:: float

distance(self) → float[source]¶

Returns the acceptable distance threshold between labels and the features from the targetLayer().

See also

setDistance()

See also

distanceUnit()

Return type:: float

distanceUnit(self) → Qgis.RenderUnit[source]¶

Returns the units for the distance between labels and the features from the targetLayer().

See also

setDistanceUnit()

See also

distance()

Return type:: Qgis.RenderUnit

distanceUnitScale(self) → QgsMapUnitScale¶

Returns the scaling for the distance between labels and the features from the targetLayer().

See also

setDistanceUnitScale()

See also

distance()

Return type:: QgsMapUnitScale

labeledLayer(self) → QgsMapLayer | None[source]¶

Returns the layer providing the labels.

See also

setLabeledLayer()

Return type:: Optional[QgsMapLayer]

setCost(self, cost: float)[source]¶

Sets the penalty cost incurred when the rule is violated.

This is a value between 0 and 10, where 10 indicates that the rule must never be violated, and 1-9 = nice to have if possible, where higher numbers will try harder to avoid violating the rule.

See also

cost()