Class: QgsPointClusterRenderer¶
-
class
qgis.core.
QgsPointClusterRenderer
¶ Bases:
QgsPointDistanceRenderer
A renderer that automatically clusters points with the same geographic position.
Methods
- param visitor
- rtype
QgsPointClusterRenderer
Returns the symbol used for rendering clustered groups (but not ownership of the symbol).
Creates a
QgsPointClusterRenderer
from an existing renderer.Clones generic renderer data to another renderer.
Creates a renderer from XML element
Render the
feature
with thesymbol
usingcontext
.render editing vertex marker at specified point
render editing vertex marker for a polygon
render editing vertex marker for a polyline
- param doc
Sets the symbol for rendering clustered groups.
- param context
- param context
- param context
-
accept
(self, visitor: QgsStyleEntityVisitorInterface) → bool¶ - Parameters
visitor (QgsStyleEntityVisitorInterface) –
- Return type
bool
-
clone
(self) → QgsPointClusterRenderer¶ - Return type
-
clusterSymbol
(self) → QgsMarkerSymbol¶ Returns the symbol used for rendering clustered groups (but not ownership of the symbol).
See also
- Return type
-
convertFromRenderer
(renderer: QgsFeatureRenderer) → QgsPointClusterRenderer¶ Creates a
QgsPointClusterRenderer
from an existing renderer.- Return type
- Returns
a new renderer if the conversion was possible, otherwise
None
.- Parameters
renderer (QgsFeatureRenderer) –
-
convertSymbolRotation
(symbol: QgsSymbol, field: str)¶ Note
this function is used to convert old rotations expressions to symbol level DataDefined angle
-
convertSymbolSizeScale
(symbol: QgsSymbol, method: QgsSymbol.ScaleMethod, field: str)¶ Note
this function is used to convert old sizeScale expressions to symbol level DataDefined size
-
copyRendererData
(self, destRenderer: QgsFeatureRenderer)¶ Clones generic renderer data to another renderer. Currently clones
Order By
Paint Effect
- Parameters
destRenderer – destination renderer for copied effect
-
create
(symbologyElem: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer¶ Creates a renderer from XML element
- Parameters
symbologyElem (QDomElement) –
context (QgsReadWriteContext) –
- Return type
-
drawGroup
()¶
-
drawLabels
()¶
-
renderFeatureWithSymbol
(self, feature: QgsFeature, symbol: QgsSymbol, context: QgsRenderContext, layer: int, selected: bool, drawVertexMarker: bool)¶ Render the
feature
with thesymbol
usingcontext
. Uselayer
to specify the symbol layer,selected
to specify if it should be rendered as selected anddrawVertexMarker
to specify if vertex markers should be rendered.
-
renderVertexMarker
(self, pt: Union[QPointF, QPoint], context: QgsRenderContext)¶ render editing vertex marker at specified point
-
renderVertexMarkerPolygon
(self, pts: QPolygonF, rings: Iterable[QPolygonF], context: QgsRenderContext)¶ render editing vertex marker for a polygon
-
renderVertexMarkerPolyline
(self, pts: QPolygonF, context: QgsRenderContext)¶ render editing vertex marker for a polyline
-
save
(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement¶ - Parameters
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement
-
setClusterSymbol
(self, symbol: QgsMarkerSymbol)¶ Sets the symbol for rendering clustered groups.
- Parameters
symbol (QgsMarkerSymbol) – new cluster symbol. Ownership is transferred to the renderer.
See also
-
startRender
(self, context: QgsRenderContext, fields: QgsFields)¶ - Parameters
context (QgsRenderContext) –
fields (QgsFields) –
-
stopRender
(self, context: QgsRenderContext)¶ - Parameters
context (QgsRenderContext) –
-
usedAttributes
(self, context: QgsRenderContext) → Set[str]¶ - Parameters
context (QgsRenderContext) –
- Return type
Set[str]