Class: QgsLabelingEngineRuleMinimumDistanceLabelToLabel

A labeling engine rule which prevents labels being placed too close to labels from a different layer.

Added in version 3.40.

Class Hierarchy

Base classes

QgsAbstractLabelingEngineRule

Abstract base class for labeling engine rules.

Methods

distance	Returns the minimum permitted distance between labels from the labeledLayer() and the labels from the targetLayer().
distanceUnit	Returns the units for the distance between labels from the labeledLayer() and the labels from the targetLayer().
distanceUnitScale	Returns the scaling for the distance between labels from the labeledLayer() and the labels from the targetLayer().
labeledLayer	Returns the layer providing the labels.
setDistance	Sets the minimum permitted distance between labels from the labeledLayer() and the labels from the targetLayer().
setDistanceUnit	Sets the unit for the distance between labels from the labeledLayer() and the labels from the targetLayer().
setDistanceUnitScale	Sets the scale for the distance between labels from the labeledLayer() and the labels from the targetLayer().
setLabeledLayer	Sets the layer providing the labels.
setTargetLayer	Sets the layer providing the labels which labels must be distant from.
targetLayer	Returns the layer providing the labels which labels must be distant from.

class qgis.core.QgsLabelingEngineRuleMinimumDistanceLabelToLabel

Bases: QgsAbstractLabelingEngineRule

distance(self) → float

Returns the minimum permitted distance between labels from the labeledLayer() and the labels from the targetLayer().

See also

setDistance()

See also

distanceUnit()

Return type:

float

distanceUnit(self) → Qgis.RenderUnit

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

See also

setDistanceUnit()

See also

distance()

Return type:

Qgis.RenderUnit

distanceUnitScale(self) → QgsMapUnitScale

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

See also

setDistanceUnitScale()

See also

distance()

Return type:

QgsMapUnitScale

labeledLayer(self) → QgsMapLayer | None

Returns the layer providing the labels.

See also

setLabeledLayer()

Return type:

Optional[QgsMapLayer]

setDistance(self, distance: float)

Sets the minimum permitted distance between labels from the labeledLayer() and the labels from the targetLayer().

See also

distance()

See also

setDistanceUnit()

Parameters:

distance (float)

setDistanceUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the distance between labels from the labeledLayer() and the labels from the targetLayer().

See also

distanceUnit()

See also

setDistance()

Parameters:

unit (Qgis.RenderUnit)

setDistanceUnitScale(self, scale: QgsMapUnitScale)

Sets the scale for the distance between labels from the labeledLayer() and the labels from the targetLayer().

See also

distanceUnitScale()

See also

setDistance()

Parameters:

scale (QgsMapUnitScale)

setLabeledLayer(self, layer: QgsMapLayer | None)

Sets the layer providing the labels.

See also

labeledLayer()

Parameters:

layer (Optional[QgsMapLayer])

setTargetLayer(self, layer: QgsMapLayer | None)

Sets the layer providing the labels which labels must be distant from.

See also

targetLayer()

Parameters:

layer (Optional[QgsMapLayer])

targetLayer(self) → QgsMapLayer | None

Returns the layer providing the labels which labels must be distant from.

See also

setTargetLayer()

Return type:

Optional[QgsMapLayer]