Class: QgsMapCanvasAnnotationItem

An interactive map canvas item which displays a QgsAnnotation.

Class Hierarchy

Base classes

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

class qgis.gui.QgsMapCanvasAnnotationItem

Bases: QObject, QgsMapCanvasItem

__init__(annotation: QgsAnnotation | None, mapCanvas: QgsMapCanvas | None)

Constructor for QgsMapCanvasAnnotationItem.

Parameters:

• annotation (Optional[QgsAnnotation])

• mapCanvas (Optional[QgsMapCanvas])

class MouseMoveAction

Bases: int

MoveFramePosition = 2

MoveMapPosition = 1

NoAction = 0

ResizeFrameDown = 4

ResizeFrameLeft = 5

ResizeFrameLeftDown = 9

ResizeFrameLeftUp = 7

ResizeFrameRight = 6

ResizeFrameRightDown = 10

ResizeFrameRightUp = 8

ResizeFrameUp = 3

annotation(self) → QgsAnnotation | None

Returns the item’s annotation.

Return type:

Optional[QgsAnnotation]

cursorShapeForAction(self, moveAction: QgsMapCanvasAnnotationItem.MouseMoveAction) → Qt.CursorShape

Returns matching cursor shape for a mouse move action.

Parameters:

moveAction (QgsMapCanvasAnnotationItem.MouseMoveAction)

Return type:

Qt.CursorShape

moveActionForPosition(self, pos: QPointF | QPoint) → QgsMapCanvasAnnotationItem.MouseMoveAction

Returns the mouse move behavior for a given position in scene coordinates

Parameters:

pos (Union[QPointF, QPoint])

Return type:

QgsMapCanvasAnnotationItem.MouseMoveAction