Class: QgsHighlight¶

A class for highlight features on the map.

The QgsHighlight class provides a transparent overlay canvas item for highlighting features or geometries on a map canvas.

color = QColor(Qt.red)
highlight = QgsHighlight(mapCanvas, feature, layer)
highlight.setColor(color)
color.setAlpha(50)
highlight.setFillColor(color)
highlight.show()

Class Hierarchy¶

Base classes¶

`QgsMapCanvasItem`	An abstract class for items that can be placed on the map canvas.
QGraphicsItem

Methods

`applyDefaultStyle`	Applies the default style from the user settings to the highlight.
`buffer`	Returns the line/stroke buffer size (in millimeters)
`color`	Returns the line/stroke color
`fillColor`	Returns the fill color
`layer`	Returns the layer for which this highlight has been created.
`setBuffer`	Sets the line/stroke buffer size (in millimeters).
`setColor`	Set line/stroke to color, polygon fill to color with alpha = 63.
`setFillColor`	Fill color for the highlight.
`setMinWidth`	Sets the minimum line/stroke width (in millimeters).
`setWidth`	Set stroke width.
`updateRect`	recalculates needed rectangle
`width`	Returns the stroke width

class qgis.gui.QgsHighlight[source]¶

Bases: QgsMapCanvasItem

__init__(mapCanvas: QgsMapCanvas | None, geom: QgsGeometry, layer: QgsMapLayer | None)

Constructor for QgsHighlight

Parameters:

mapCanvas (Optional[QgsMapCanvas]) – associated map canvas
geom (QgsGeometry) – initial geometry of highlight
layer (Optional[QgsMapLayer]) – associated map layer

__init__(mapCanvas: QgsMapCanvas | None, feature: QgsFeature, layer: QgsVectorLayer | None)

Constructor for highlighting True feature shape using feature attributes and renderer.

Parameters:

mapCanvas (Optional[QgsMapCanvas]) – map canvas
feature (QgsFeature)
layer (Optional[QgsVectorLayer]) – vector layer

applyDefaultStyle(self)[source]¶: Applies the default style from the user settings to the highlight.

Added in version 3.30.

buffer(self) → float[source]¶

Returns the line/stroke buffer size (in millimeters)