Class: QgsHighlight

Highlights 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

class qgis.gui.QgsHighlight

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)

Applies the default style from the user settings to the highlight.

Added in version 3.30.

buffer(self) → float

Returns the line/stroke buffer size (in millimeters)

See also

setBuffer()

Added in version 3.4.

Return type:

float

color(self) → QColor

Returns the line/stroke color

Added in version 3.4.

Return type:

QColor

fillColor(self) → QColor

Returns the fill color

Added in version 3.4.

Return type:

QColor

layer(self) → QgsMapLayer | None

Returns the layer for which this highlight has been created.

Return type:

Optional[QgsMapLayer]

setBuffer(self, buffer: float)

Sets the line/stroke buffer size (in millimeters).

See also

buffer()

Parameters:

buffer (float)

setColor(self, color: QColor | Qt.GlobalColor)

Set line/stroke to color, polygon fill to color with alpha = 63. This is legacy function, use setFillColor() after setColor() if different fill color is required.

Parameters:

color (Union[QColor, Qt.GlobalColor])

setFillColor(self, fillColor: QColor | Qt.GlobalColor)

Fill color for the highlight. Will be used for polygons and points.

Parameters:

fillColor (Union[QColor, Qt.GlobalColor])

setMinWidth(self, width: float)

Sets the minimum line/stroke width (in millimeters).

Parameters:

width (float)

setWidth(self, width: int)

Set stroke width.

Note

Ignored in feature mode.

Parameters:

width (int)

updateRect(self)

recalculates needed rectangle

width(self) → int

Returns the stroke width

Added in version 3.4.

Return type:

int