Subgroup: Point

Class: QgsPointClusterRenderer¶

class qgis.core.QgsPointClusterRenderer¶

Bases: qgis._core.QgsPointDistanceRenderer

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

New in version 3.0: Methods

`capabilities`
`checkLegendSymbolItem`
`clone`
`clusterSymbol`	Returns the symbol used for rendering clustered groups (but not ownership of the symbol).
`convertFromRenderer`	Creates a QgsPointClusterRenderer from an existing renderer.
`convertSymbolRotation`
`convertSymbolSizeScale`
`copyRendererData`
`create`	Creates a renderer from XML element
`defaultRenderer`	return a new renderer - used by default in vector layers
`drawGroup`
`drawLabels`
`dump`	Returns debug information about this renderer
`embeddedRenderer`
`filter`
`filterNeedsGeometry`	Returns true if this renderer requires the geometry to apply the filter.
`forceRasterRender`	Returns whether the renderer must render as a raster.
`labelAttributeName`	Returns the attribute name used for labeling points, or an empty string if no labeling will be done by the renderer.
`labelColor`	Returns the color used for for labeling points.
`labelFont`	Returns the font used for labeling points.
`legendClassificationAttribute`	If supported by the renderer, return classification attribute for the use in legend
`legendKeysForFeature`
`legendSymbolItemChecked`
`legendSymbolItems`
`legendSymbolItemsCheckable`
`load`	create a renderer from XML element
`loadSld`	Create a new renderer according to the information contained in
`minimumLabelScale`	Returns the minimum map scale (i.e.
`modifyRequestExtent`	Allows for a renderer to modify the extent of a feature request prior to rendering
`orderBy`	Get the order in which features shall be processed by this renderer.
`orderByEnabled`	Returns whether custom ordering will be applied before features are processed by this renderer.
`originalSymbolForFeature`
`originalSymbolsForFeature`
`paintEffect`	Returns the current paint effect for the renderer.
`renderFeature`
`renderFeatureWithSymbol`
`renderVertexMarker`
`renderVertexMarkerPolygon`
`renderVertexMarkerPolyline`
`save`
`setClusterSymbol`	Sets the symbol for rendering clustered groups.
`setEmbeddedRenderer`
`setForceRasterRender`	Sets whether the renderer should be rendered to a raster destination.
`setLabelAttributeName`	Sets the attribute name for labeling points.
`setLabelColor`	Sets the color to use for for labeling points.
`setLabelFont`	Sets the font used for labeling points.
`setLegendSymbolItem`
`setMinimumLabelScale`	Sets the minimum map `scale` (i.e.
`setOrderBy`	Define the order in which features shall be processed by this renderer.
`setOrderByEnabled`	Sets whether custom ordering should be applied before features are processed by this renderer.
`setPaintEffect`	Sets the current paint effect for the renderer.
`setTolerance`	Sets the tolerance distance for grouping points.
`setToleranceMapUnitScale`	Sets the map unit scale object for the distance tolerance.
`setToleranceUnit`	Sets the units for the tolerance distance.
`setUsingSymbolLevels`
`setVertexMarkerAppearance`	set type and size of editing vertex markers for subsequent rendering
`startRender`
`stopRender`
`symbolForFeature`
`symbols`
`symbolsForFeature`
`toSld`
`tolerance`	Returns the tolerance distance for grouping points.
`toleranceMapUnitScale`	Returns the map unit scale object for the distance tolerance.
`toleranceUnit`	Returns the units for the tolerance distance.
`type`
`usedAttributes`
`usingSymbolLevels`
`willRenderFeature`
`writeSld`	create the SLD UserStyle element following the SLD v1.1 specs with the given name

Attributes

`Filter`
`MoreSymbolsPerFeature`
`ScaleDependent`
`SymbolLevels`

clone(self) → QgsPointClusterRenderer¶

clusterSymbol(self) → QgsMarkerSymbol¶: Returns the symbol used for rendering clustered groups (but not ownership of the symbol).

See also

setClusterSymbol()

convertFromRenderer(renderer: QgsFeatureRenderer) → QgsPointClusterRenderer¶

Creates a QgsPointClusterRenderer from an existing renderer.

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

convertSymbolRotation()¶

convertSymbolSizeScale()¶

copyRendererData()¶

create(symbologyElem: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer¶: Creates a renderer from XML element

drawGroup()¶

drawLabels()¶

renderFeatureWithSymbol()¶

renderVertexMarker()¶

renderVertexMarkerPolygon()¶

renderVertexMarkerPolyline()¶

save(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement¶

setClusterSymbol(self, symbol: QgsMarkerSymbol)¶

Sets the symbol for rendering clustered groups.

Parameters:	symbol – new cluster symbol. Ownership is transferred to the renderer.