Class: QgsPointDistanceRenderer

class qgis.core.QgsPointDistanceRenderer(rendererName: str, labelAttributeName: str = '')

Bases: QgsFeatureRenderer

Constructor for QgsPointDistanceRenderer.

Parameters
  • rendererName (str) – name of renderer for registry

  • labelAttributeName (str = '') – optional attribute for labeling points

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.

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.

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 (QgsFeature) – feature

  • symbol (QgsMarkerSymbol) – base symbol for rendering feature (owned by GroupedFeature)

  • isSelected (bool) – set to True if feature is selected and should be rendered in a selected state

  • label (str = '') – 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

labelFont()

See also

labelColor()

Return type

str

labelColor(self) → QColor

Returns the color used for for labeling points.

See also

setLabelColor()

See also

labelFont()

Return type

QColor

labelFont(self) → QFont

Returns the font used for labeling points.

See also

setLabelFont()

See also

labelColor()

Return type

QFont

legendKeysForFeature(self, feature: QgsFeature, context: QgsRenderContext) → Set[str]
Parameters
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.

Return type

float

originalSymbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol
Parameters
Return type

QgsSymbol

originalSymbolsForFeature(self, feature: QgsFeature, context: QgsRenderContext) → List[QgsSymbol]
Parameters
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

setLabelFont()

See also

setLabelColor()

setLabelColor(self, color: Union[QColor, Qt.GlobalColor])

Sets the color to use for for labeling points.

Parameters

color (Union[QColor) – label color

See also

labelColor()

See also

setLabelFont()

setLabelFont(self, font: QFont)

Sets the font used for labeling points.

Parameters

font (QFont) – label font

See also

labelFont()

See also

setLabelColor()

setLegendSymbolItem(self, key: str, symbol: QgsSymbol)
Parameters
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.

Parameters

scale (float) –

setTolerance(self, distance: float)

Sets the tolerance distance for grouping points. Units are specified using setToleranceUnit().

Parameters

distance (float) – tolerance distance

See also

tolerance()

setToleranceMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale object for the distance tolerance. This is only used if the toleranceUnit() is set to QgsUnitTypes.RenderMapUnits.

Parameters

scale (QgsMapUnitScale) – scale for distance tolerance

setToleranceUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units for the tolerance distance.

Parameters

unit (QgsUnitTypes.RenderUnit) – tolerance distance units

See also

setTolerance()

See also

toleranceUnit()

New in version 2.12.

startRender(self, context: QgsRenderContext, fields: QgsFields)
Parameters
stopRender(self, context: QgsRenderContext)
Parameters

context (QgsRenderContext) –

symbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol
Parameters
Return type

QgsSymbol

symbols(self, context: QgsRenderContext) → List[QgsSymbol]
Parameters

context (QgsRenderContext) –

Return type

List[QgsSymbol]

symbolsForFeature(self, feature: QgsFeature, context: QgsRenderContext) → List[QgsSymbol]
Parameters
Return type

List[QgsSymbol]

toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str] = {})
Parameters
  • doc (QDomDocument) –

  • element (QDomElement) –

  • props (Dict[str) –

tolerance(self) → float

Returns the tolerance distance for grouping points. Units are retrieved using toleranceUnit().

See also

setTolerance()

See also

toleranceUnit()

Return type

float

toleranceMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale object for the distance tolerance. This is only used if the toleranceUnit() is set to QgsUnitTypes.RenderMapUnits.

See also

toleranceUnit()

Return type

QgsMapUnitScale

toleranceUnit(self) → QgsUnitTypes.RenderUnit

Returns the units for the tolerance distance.

See also

tolerance()

New in version 2.12.

Return type

QgsUnitTypes.RenderUnit

usedAttributes(self, context: QgsRenderContext) → Set[str]
Parameters

context (QgsRenderContext) –

Return type

Set[str]

willRenderFeature(self, feature: QgsFeature, context: QgsRenderContext) → bool
Parameters
Return type

bool