Class: QgsPointDisplacementRenderer

A renderer that automatically displaces points with the same geographic location.

Class Hierarchy

Base classes

QgsPointDistanceRenderer	An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers).
QgsFeatureRenderer	Abstract base class for all 2D vector feature renderers.

Abstract Methods

drawGroup

Methods

centerSymbol	Returns the symbol for the center of a displacement group (but not ownership of the symbol).
circleColor	Returns the color used for drawing the displacement group circle.
circleRadiusAddition	Returns the factor for increasing the ring size of displacement groups.
circleWidth	Returns the line width for the displacement group circle in mm.
drawLabels
labelDistanceFactor	Returns the factor for label distance from the symbol.
placement	Returns the placement method used for dispersing the points.
setCenterSymbol	Sets the center symbol for a displacement group.
setCircleColor	Sets the color used for drawing the displacement group circle.
setCircleRadiusAddition	Sets a factor for increasing the ring size of displacement groups.
setCircleWidth	Sets the line width for the displacement group circle.
setLabelDistanceFactor	Sets a factor for increasing the label distances from the symbol.
setPlacement	Sets the placement method used for dispersing the points.

Static Methods

convertFromRenderer	Creates a QgsPointDisplacementRenderer from an existing renderer.
create	Create a renderer from XML element

Attributes

ConcentricRings
Grid
Ring

class qgis.core.QgsPointDisplacementRenderer

Bases: QgsPointDistanceRenderer

__init__(labelAttributeName: str | None = '')

Constructor for QgsPointDisplacementRenderer.

Parameters:

labelAttributeName (Optional[str] = '') – optional attribute name for labeling points

ConcentricRings = 1

Grid = 2

class Placement

Bases: int

Ring = 0

centerSymbol(self) → QgsMarkerSymbol | None

Returns the symbol for the center of a displacement group (but not ownership of the symbol).

See also

setCenterSymbol()

Return type:

Optional[QgsMarkerSymbol]

circleColor(self) → QColor

Returns the color used for drawing the displacement group circle.

See also

setCircleColor()

See also

circleWidth()

Return type:

QColor

circleRadiusAddition(self) → float

Returns the factor for increasing the ring size of displacement groups.

See also

setCircleRadiusAddition()

Return type:

float

circleWidth(self) → float

Returns the line width for the displacement group circle in mm.

See also

setCircleWidth()

See also

circleColor()

Return type:

float

static convertFromRenderer(renderer: QgsFeatureRenderer | None) → QgsPointDisplacementRenderer | None

Creates a QgsPointDisplacementRenderer from an existing renderer.

Return type:

Optional[QgsPointDisplacementRenderer]

Returns:

a new renderer if the conversion was possible, otherwise None.

Parameters:

renderer (Optional[QgsFeatureRenderer])

static create(symbologyElem: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer | None

Create a renderer from XML element

Parameters:

• symbologyElem (QDomElement)

• context (QgsReadWriteContext)

Return type:

Optional[QgsFeatureRenderer]

abstract drawGroup()

drawLabels()

labelDistanceFactor(self) → float

Returns the factor for label distance from the symbol.

See also

setLabelDistanceFactor()

Added in version 3.8.

Return type:

float

placement(self) → QgsPointDisplacementRenderer.Placement

Returns the placement method used for dispersing the points.

See also

setPlacement()

Return type:

QgsPointDisplacementRenderer.Placement

setCenterSymbol(self, symbol: QgsMarkerSymbol | None)

Sets the center symbol for a displacement group.

Parameters:

symbol (Optional[QgsMarkerSymbol]) – new center symbol. Ownership is transferred to the renderer.

See also

centerSymbol()

setCircleColor(self, color: QColor | Qt.GlobalColor)

Sets the color used for drawing the displacement group circle.

Parameters:

color (Union[QColor, Qt.GlobalColor]) – circle color

See also

circleColor()

See also

setCircleWidth()

setCircleRadiusAddition(self, distance: float)

Sets a factor for increasing the ring size of displacement groups.

Parameters:

distance (float) – addition factor

See also

circleRadiusAddition()

setCircleWidth(self, width: float)

Sets the line width for the displacement group circle.

Parameters:

width (float) – line width in mm

See also

circleWidth()

See also

setCircleColor()

setLabelDistanceFactor(self, factor: float)

Sets a factor for increasing the label distances from the symbol.

Parameters:

factor (float) – addition factor

See also

labelDistanceFactor()

Added in version 3.8.

setPlacement(self, placement: QgsPointDisplacementRenderer.Placement)

Sets the placement method used for dispersing the points.

Parameters:

placement (QgsPointDisplacementRenderer.Placement) – placement method

See also

placement()