Class: QgsPointDisplacementRenderer¶

class qgis.core.QgsPointDisplacementRenderer¶

Bases: QgsPointDistanceRenderer

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

QgsPointDisplacementRenderer(labelAttributeName: Optional[str] = ‘’) Constructor for QgsPointDisplacementRenderer.

Parameters:

labelAttributeName –

optional attribute name for labeling points

Methods

`accept`	param visitor:
`centerSymbol`	Returns the symbol for the center of a displacement group (but not ownership of the symbol).
`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`	rtype: Optional[QgsPointDisplacementRenderer]
`convertFromRenderer`	Creates a `QgsPointDisplacementRenderer` from an existing renderer.
`convertSymbolRotation`
`convertSymbolSizeScale`
`create`	Create a renderer from XML element
`drawGroup`
`drawLabels`
`labelDistanceFactor`	Returns the factor for label distance from the symbol.
`placement`	Returns the placement method used for dispersing the points.
`renderFeatureWithSymbol`	Render the `feature` with the `symbol` using `context`.
`renderVertexMarker`	render editing vertex marker at specified point
`renderVertexMarkerPolygon`	render editing vertex marker for a polygon
`renderVertexMarkerPolyline`	render editing vertex marker for a polyline
`save`	param doc:
`saveRendererData`	Saves generic renderer data into the specified `element`.
`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.
`setLabelDistanceFactor`	Sets a factor for increasing the label distances from the symbol.
`setPlacement`	Sets the placement method used for dispersing the points.
`startRender`	param context:
`stopRender`	param context:
`usedAttributes`	param context:

Signals

`ConcentricRings`
`Grid`
`Ring`

Attributes

`ConcentricRings`
`Grid`
`Ring`

ConcentricRings = 1¶

Grid = 2¶

class Placement¶: Bases: int

Ring = 0¶

accept(self, visitor: QgsStyleEntityVisitorInterface | None) → bool¶

Parameters:: visitor (Optional[QgsStyleEntityVisitorInterface])
Return type:: bool

centerSymbol(self) → QgsMarkerSymbol | None¶

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

See also

setCenterSymbol()

Return type:: Optional[QgsMarkerSymbol]

circleColor(self) → QColor¶

Returns the color used for drawing the displacement group circle.

See also

setCircleColor()

See also

circleWidth()

Return type:: QColor

circleRadiusAddition(self) → float¶

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

See also

setCircleRadiusAddition()

Return type:: float

circleWidth(self) → float¶

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

See also

setCircleWidth()

See also

circleColor()

Return type:: float

clone(self) → QgsPointDisplacementRenderer | None¶

Return type:: Optional[QgsPointDisplacementRenderer]

convertFromRenderer(renderer: QgsFeatureRenderer | None) → QgsPointDisplacementRenderer | None¶

Creates a QgsPointDisplacementRenderer from an existing renderer.

Return type:: Optional[QgsPointDisplacementRenderer]
Returns:: a new renderer if the conversion was possible, otherwise None.

Added in version 2.5.

Parameters:: renderer (Optional[QgsFeatureRenderer])

convertSymbolRotation(symbol: QgsSymbol | None, field: str | None)¶: Note

this function is used to convert old rotations expressions to symbol level DataDefined angle

convertSymbolSizeScale(symbol: QgsSymbol | None, method: Qgis.ScaleMethod, field: str | None)¶: Note

this function is used to convert old sizeScale expressions to symbol level DataDefined size

create(symbologyElem: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer | None¶

Create a renderer from XML element

Parameters:

symbologyElem (QDomElement)
context (QgsReadWriteContext)

Return type:

Optional[QgsFeatureRenderer]

drawGroup()¶

drawLabels()¶

labelDistanceFactor(self) → float¶

Returns the factor for label distance from the symbol.

See also

setLabelDistanceFactor()

Added in version 3.8.

Return type:: float

placement(self) → QgsPointDisplacementRenderer.Placement¶

Returns the placement method used for dispersing the points.

See also

setPlacement()

Added in version 2.12.

Return type:: QgsPointDisplacementRenderer.Placement

renderFeatureWithSymbol(self, feature: QgsFeature, symbol: QgsSymbol | None, context: QgsRenderContext, layer: int, selected: bool, drawVertexMarker: bool)¶: Render the feature with the symbol using context. Use layer to specify the symbol layer, selected to specify if it should be rendered as selected and drawVertexMarker to specify if vertex markers should be rendered.

renderVertexMarker(self, pt: QPointF | QPoint, context: QgsRenderContext)¶: render editing vertex marker at specified point

renderVertexMarkerPolygon(self, pts: QPolygonF, rings: Iterable[QPolygonF] | None, context: QgsRenderContext)¶: render editing vertex marker for a polygon