Subgroup: Point

Class: QgsPointDisplacementRenderer¶

class qgis.core.QgsPointDisplacementRenderer¶

Bases: qgis._core.QgsPointDistanceRenderer

A renderer that automatically displaces points with the same geographic location.

Methods

capabilities

centerSymbol Returns the symbol for the center of a displacement group (but not ownership of the symbol).

checkLegendSymbolItem

circleColor Returns the color used for drawing the displacement group circle.

circleRadiusAddition Returns the factor for increasing the ring size of displacement groups.

circleWidth Returns the line width for the displacement group circle in mm.

clone

convertFromRenderer Creates a QgsPointDisplacementRenderer from an existing renderer.

convertSymbolRotation

convertSymbolSizeScale

copyRendererData

create Create 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.

placement Returns the placement method used for dispersing the points.

renderFeature

renderFeatureWithSymbol

renderVertexMarker

renderVertexMarkerPolygon

renderVertexMarkerPolyline

save

setCenterSymbol Sets the center symbol for a displacement group.

setCircleColor Sets the color used for drawing the displacement group circle.

setCircleRadiusAddition Sets a factor for increasing the ring size of displacement groups.

setCircleWidth Sets the line width for the displacement group circle.

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.

setPlacement Sets the placement method used for dispersing the points.

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

ConcentricRings

Filter

Grid

MoreSymbolsPerFeature

Ring

ScaleDependent

SymbolLevels

ConcentricRings = 1¶

Grid = 2¶

class Placement¶: Bases: int

Ring = 0¶

centerSymbol(self) → QgsMarkerSymbol¶: Returns the symbol for the center of a displacement group (but not ownership of the symbol).

See also

setCenterSymbol()

circleColor(self) → QColor¶: Returns the color used for drawing the displacement group circle.

See also

setCircleColor()

See also

circleWidth()

circleRadiusAddition(self) → float¶: Returns the factor for increasing the ring size of displacement groups.

See also

setCircleRadiusAddition()

circleWidth(self) → float¶: Returns the line width for the displacement group circle in mm.

See also

setCircleWidth()

See also

circleColor()

clone(self) → QgsPointDisplacementRenderer¶

convertFromRenderer(renderer: QgsFeatureRenderer) → QgsPointDisplacementRenderer¶

Creates a QgsPointDisplacementRenderer from an existing renderer.

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

New in version 2.5.

convertSymbolRotation()¶

convertSymbolSizeScale()¶

copyRendererData()¶

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

drawGroup()¶

drawLabels()¶

placement(self) → QgsPointDisplacementRenderer.Placement¶: Returns the placement method used for dispersing the points.

See also

setPlacement()

New in version 2.12.

renderFeatureWithSymbol()¶

renderVertexMarker()¶

renderVertexMarkerPolygon()¶

renderVertexMarkerPolyline()¶

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

setCenterSymbol(self, symbol: QgsMarkerSymbol)¶

Sets the center symbol for a displacement group.

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

See also

centerSymbol()

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

Sets the color used for drawing the displacement group circle.

Parameters:	color – circle color

See also

circleColor()

See also

setCircleWidth()

setCircleRadiusAddition(self, distance: float)¶

Sets a factor for increasing the ring size of displacement groups.

Parameters:	distance – addition factor

See also

circleRadiusAddition()

setCircleWidth(self, width: float)¶

Sets the line width for the displacement group circle.

Parameters:	width – line width in mm

See also

circleWidth()

See also

setCircleColor()

setPlacement(self, placement: QgsPointDisplacementRenderer.Placement)¶

Sets the placement method used for dispersing the points.

Parameters:	placement – placement method

See also

placement()

New in version 2.12.

startRender(self, context: QgsRenderContext, fields: QgsFields)¶

stopRender(self, context: QgsRenderContext)¶

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