Class: QgsHighlight¶
- class qgis.gui.QgsHighlight¶
Bases:
QgsMapCanvasItem
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()
QgsHighlight(mapCanvas:
QgsMapCanvas
, geom:QgsGeometry
, layer:QgsMapLayer
) Constructor for QgsHighlight- Parameters:
mapCanvas – associated map canvas
geom – initial geometry of highlight
layer – associated map layer
QgsHighlight(mapCanvas:
QgsMapCanvas
, feature:QgsFeature
, layer:QgsVectorLayer
) Constructor for highlightingTrue
feature shape using feature attributes and renderer.- Parameters:
mapCanvas – map canvas
feature –
layer –
vector layer
Methods
Applies the default style from the user settings to the highlight.
Returns the buffer
Returns the line/stroke color
Returns the fill color
Returns the layer for which this highlight has been created.
- param p:
Set line / stroke buffer in millimeters.
Set line/stroke to color, polygon fill to color with alpha = 63.
Fill color for the highlight.
Set minimum line / stroke width in millimeters.
Sets render context parameters
Set stroke width.
schedules map canvas for repaint
recalculates needed rectangle
Returns the stroke width
- applyDefaultStyle(self)¶
Applies the default style from the user settings to the highlight.
New in version 3.30.
- buffer(self) float ¶
Returns the buffer
New in version 3.4.
- Return type:
float
- color(self) QColor ¶
Returns the line/stroke color
New in version 3.4.
- Return type:
QColor
- contextMenuEvent(self, QGraphicsSceneContextMenuEvent)¶
- dragEnterEvent(self, QGraphicsSceneDragDropEvent)¶
- dragLeaveEvent(self, QGraphicsSceneDragDropEvent)¶
- dragMoveEvent(self, QGraphicsSceneDragDropEvent)¶
- dropEvent(self, QGraphicsSceneDragDropEvent)¶
- fillColor(self) QColor ¶
Returns the fill color
New in version 3.4.
- Return type:
QColor
- focusInEvent(self, QFocusEvent)¶
- focusOutEvent(self, QFocusEvent)¶
- hoverEnterEvent(self, QGraphicsSceneHoverEvent)¶
- hoverLeaveEvent(self, QGraphicsSceneHoverEvent)¶
- hoverMoveEvent(self, QGraphicsSceneHoverEvent)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- inputMethodQuery(self, Qt.InputMethodQuery) Any ¶
- itemChange(self, QGraphicsItem.GraphicsItemChange, Any) Any ¶
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- layer(self) QgsMapLayer ¶
Returns the layer for which this highlight has been created.
- Return type:
- mouseDoubleClickEvent(self, QGraphicsSceneMouseEvent)¶
- mouseMoveEvent(self, QGraphicsSceneMouseEvent)¶
- mousePressEvent(self, QGraphicsSceneMouseEvent)¶
- mouseReleaseEvent(self, QGraphicsSceneMouseEvent)¶
- paint(self, p: QPainter)¶
- Parameters:
p (QPainter) –
- prepareGeometryChange(self)¶
- sceneEvent(self, QEvent) bool ¶
- sceneEventFilter(self, QGraphicsItem, QEvent) bool ¶
- setBuffer(self, buffer: float)¶
Set line / stroke buffer in millimeters.
- Parameters:
buffer (float) –
- setColor(self, color: QColor | Qt.GlobalColor | QGradient)¶
Set line/stroke to color, polygon fill to color with alpha = 63. This is legacy function, use
setFillColor()
aftersetColor()
if different fill color is required.- Parameters:
color (Union[QColor) –
- setFillColor(self, fillColor: QColor | Qt.GlobalColor | QGradient)¶
Fill color for the highlight. Will be used for polygons and points.
- Parameters:
fillColor (Union[QColor) –
- setMinWidth(self, width: float)¶
Set minimum line / stroke width in millimeters.
- Parameters:
width (float) –
- setRenderContextVariables(self, p: QPainter, context: QgsRenderContext) bool ¶
Sets render context parameters
- Parameters:
p – painter for rendering
context – out: configured context
- Returns:
True
in case of success
- setWidth(self, width: int)¶
Set stroke width.
Note
Ignored in feature mode.
- Parameters:
width (int) –
- updateCanvas(self)¶
schedules map canvas for repaint
- updateMicroFocus(self)¶
- updatePosition(self)¶
- updateRect(self)¶
recalculates needed rectangle
- wheelEvent(self, QGraphicsSceneWheelEvent)¶
- width(self) int ¶
Returns the stroke width
New in version 3.4.
- Return type:
int