Class: QgsPointDistanceRenderer¶

class qgis.core.QgsPointDistanceRenderer¶

Bases: QgsFeatureRenderer

An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers). QgsPointDistanceRenderer handles calculation of point clusters using a distance based threshold. Subclasses must implement drawGroup() to handle the rendering of individual point clusters in the desired style.

New in version 3.0.

QgsPointDistanceRenderer(rendererName: str, labelAttributeName: str = ‘’) Constructor for QgsPointDistanceRenderer.

Parameters:

rendererName – name of renderer for registry

labelAttributeName –

optional attribute for labeling points

Methods

`accept`	param visitor:
`capabilities`	rtype: QgsFeatureRenderer.Capabilities
`checkLegendSymbolItem`	param key:
`embeddedRenderer`	rtype: QgsFeatureRenderer
`filter`	param fields:
`filterNeedsGeometry`	rtype: bool
`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.
`legendKeyToExpression`	param key:
`legendKeysForFeature`	param feature:
`legendSymbolItemChecked`	param key:
`legendSymbolItems`	rtype: List[QgsLegendSymbolItem]
`legendSymbolItemsCheckable`	rtype: bool
`minimumLabelScale`	Returns the minimum map scale (i.e.
`originalSymbolForFeature`	param feature:
`originalSymbolsForFeature`	param feature:
`renderFeature`	param feature:
`setEmbeddedRenderer`	param r:
`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`	param key:
`setMinimumLabelScale`	Sets the minimum map `scale` (i.e.
`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.
`startRender`	param context:
`stopRender`	param context:
`symbolForFeature`	param feature:
`symbols`	param context:
`symbolsForFeature`	param feature:
`toSld`	param doc:
`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.
`usedAttributes`	param context:
`willRenderFeature`	param feature:

class GroupedFeature(feature: QgsFeature, symbol: QgsMarkerSymbol, isSelected: bool, label: str = '')¶

Bases: sip.wrapper

Constructor for GroupedFeature.

Parameters:

feature – feature
symbol – base symbol for rendering feature (owned by GroupedFeature)
isSelected – set to True if feature is selected and should be rendered in a selected state
label – optional label text, or empty string for no label

QgsPointDistanceRenderer.GroupedFeature(QgsPointDistanceRenderer.GroupedFeature)

feature¶

isSelected¶

label¶

symbol(self) → QgsMarkerSymbol¶

Base symbol for rendering feature

Return type:: QgsMarkerSymbol

accept(self, visitor: QgsStyleEntityVisitorInterface) → bool¶

Parameters:: visitor (QgsStyleEntityVisitorInterface) –
Return type:: bool

capabilities(self) → QgsFeatureRenderer.Capabilities¶

Return type:: QgsFeatureRenderer.Capabilities

checkLegendSymbolItem(self, key: str, state: bool)¶

Parameters:

key (str) –
state (bool) –

embeddedRenderer(self) → QgsFeatureRenderer¶

Return type:: QgsFeatureRenderer

filter(self, fields: QgsFields = QgsFields()) → str¶

Parameters:: fields (QgsFields = QgsFields()) –
Return type:: str

filterNeedsGeometry(self) → bool¶

Return type:: bool

labelAttributeName(self) → str¶

Returns the attribute name used for labeling points, or an empty string if no labeling will be done by the renderer.

See also

setLabelAttributeName()

See also

labelFont()

See also

minimumLabelScale()

See also

labelColor()

Return type:: str

labelColor(self) → QColor¶

Returns the color used for for labeling points.

See also

setLabelColor()

See also

labelAttributeName()

See also

labelFont()

Return type:: QColor

labelFont(self) → QFont¶

Returns the font used for labeling points.

See also

setLabelFont()

See also

labelAttributeName()

See also

labelColor()

Return type:: QFont

legendKeyToExpression(self, key: str, layer: QgsVectorLayer) → Tuple[str, bool]¶

Parameters:

key (str) –
layer (QgsVectorLayer) –

Return type:

Tuple[str, bool]

legendKeysForFeature(self, feature: QgsFeature, context: QgsRenderContext) → Set[str]¶

Parameters:

feature (QgsFeature) –
context (QgsRenderContext) –

Return type:

Set[str]

legendSymbolItemChecked(self, key: str) → bool¶

Parameters:: key (str) –
Return type:: bool

legendSymbolItems(self) → List[QgsLegendSymbolItem]¶

Return type:: List[QgsLegendSymbolItem]

legendSymbolItemsCheckable(self) → bool¶

Return type:: bool

minimumLabelScale(self) → float¶

Returns the minimum map scale (i.e. most “zoomed out”) at which points should be labeled by the renderer. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

setMinimumLabelScale()

See also

labelAttributeName()

Return type:: float

originalSymbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol¶

Parameters:

feature (QgsFeature) –
context (QgsRenderContext) –

Return type:

QgsSymbol

originalSymbolsForFeature(self, feature: QgsFeature, context: QgsRenderContext) → List[QgsSymbol]¶

Parameters:

feature (QgsFeature) –
context (QgsRenderContext) –

Return type:

List[QgsSymbol]

renderFeature(self, feature: QgsFeature, context: QgsRenderContext, layer: int = -1, selected: bool = False, drawVertexMarker: bool = False) → bool¶

Parameters:

feature (QgsFeature) –
context (QgsRenderContext) –
layer (int = -1) –
selected (bool = False) –
drawVertexMarker (bool = False) –

Return type:

bool

setEmbeddedRenderer(self, r: QgsFeatureRenderer)¶

Parameters:: r (QgsFeatureRenderer) –

setLabelAttributeName(self, name: str)¶

Sets the attribute name for labeling points.

Parameters:: name (str) – attribute name, or empty string to avoid labeling features by the renderer

See also

labelAttributeName()

See also

setLabelFont()

See also

setLabelColor()

See also

setMinimumLabelScale()

setLabelColor(self, color: QColor | Qt.GlobalColor)¶

Sets the color to use for for labeling points.

Parameters:: color (Union[QColor) – label color

See also

labelColor()

See also

setLabelAttributeName()

See also

setLabelFont()

setLabelFont(self, font: QFont)¶

Sets the font used for labeling points.

Parameters:: font (QFont) – label font

See also

labelFont()

See also

setLabelAttributeName()

See also

setLabelColor()

setLegendSymbolItem(self, key: str, symbol: QgsSymbol)¶

Parameters:

key (str) –
symbol (QgsSymbol) –

setMinimumLabelScale(self, scale: float)¶

Sets the minimum map scale (i.e. most “zoomed out”) at which points should be labeled by the renderer. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

minimumLabelScale()

See also

setLabelAttributeName()