Class: QgsLabelingEngineRuleAvoidLabelOverlapWithFeature

A labeling engine rule which prevents labels being placed overlapping features from a different layer.

Added in version 3.40.

Class Hierarchy

Base classes

QgsAbstractLabelingEngineRule

Abstract base class for labeling engine rules.

Methods

labeledLayer	Returns the layer providing the labels.
setLabeledLayer	Sets the layer providing the labels.
setTargetLayer	Sets the layer providing the features which labels must not overlap.
targetLayer	Returns the layer providing the features which labels must not overlap.

class qgis.core.QgsLabelingEngineRuleAvoidLabelOverlapWithFeature

Bases: QgsAbstractLabelingEngineRule

labeledLayer(self) → QgsMapLayer | None

Returns the layer providing the labels.

See also

setLabeledLayer()

Return type:

Optional[QgsMapLayer]

setLabeledLayer(self, layer: QgsMapLayer | None)

Sets the layer providing the labels.

See also

labeledLayer()

Parameters:

layer (Optional[QgsMapLayer])

setTargetLayer(self, layer: QgsVectorLayer | None)

Sets the layer providing the features which labels must not overlap.

See also

targetLayer()

Parameters:

layer (Optional[QgsVectorLayer])

targetLayer(self) → QgsVectorLayer | None

Returns the layer providing the features which labels must not overlap.

See also

setTargetLayer()

Return type:

Optional[QgsVectorLayer]