Class: QgsPointClusterRenderer

A renderer that automatically clusters points with the same geographic position.

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

clusterSymbol	Returns the symbol used for rendering clustered groups (but not ownership of the symbol).
drawLabels
setClusterSymbol	Sets the symbol for rendering clustered groups.

Static Methods

convertFromRenderer	Creates a QgsPointClusterRenderer from an existing renderer.
create	Creates a renderer from XML element

class qgis.core.QgsPointClusterRenderer

Bases: QgsPointDistanceRenderer

clusterSymbol(self) → QgsMarkerSymbol | None

Returns the symbol used for rendering clustered groups (but not ownership of the symbol).

See also

setClusterSymbol()

Return type:

Optional[QgsMarkerSymbol]

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

Creates a QgsPointClusterRenderer from an existing renderer.

Return type:

Optional[QgsPointClusterRenderer]

Returns:

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

Parameters:

renderer (Optional[QgsFeatureRenderer])

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

Creates a renderer from XML element

Parameters:

• symbologyElem (QDomElement)

• context (QgsReadWriteContext)

Return type:

Optional[QgsFeatureRenderer]

abstract drawGroup()

drawLabels()

setClusterSymbol(self, symbol: QgsMarkerSymbol | None)

Sets the symbol for rendering clustered groups.

Parameters:

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

See also

clusterSymbol()