Class: QgsMapCanvasItem

class qgis.gui.QgsMapCanvasItem(mapCanvas: QgsMapCanvas)

Bases: PyQt5.QtWidgets.QGraphicsItem

protected constructor: cannot be constructed directly

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

Parameters

mapCanvas

boundingRect(self) → QRectF
Return type

QRectF

contextMenuEvent()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
focusInEvent()
focusOutEvent()
hoverEnterEvent()
hoverLeaveEvent()
hoverMoveEvent()
inputMethodEvent()
inputMethodQuery()
itemChange()
keyPressEvent()
keyReleaseEvent()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
paint(self, painter: QPainter)

function to be implemented by derived classes

paint(self, painter: QPainter, option: QStyleOptionGraphicsItem, widget: QWidget = None)

Parameters

painter (QPainter) –

prepareGeometryChange()
rect(self) → QgsRectangle

returns canvas item rectangle in map units

Return type

QgsRectangle

sceneEvent()
sceneEventFilter()
setRect(self, r: QgsRectangle, resetRotation: bool = True)

sets canvas item rectangle in map units

Parameters
setRenderContextVariables(self, p: QPainter, context: QgsRenderContext) → bool

Sets render context parameters

Parameters
  • p (QPainter) – painter for rendering

  • context (QgsRenderContext) – out: configured context

Return type

bool

Returns

true in case of success

toCanvasCoordinates(self, point: QgsPointXY) → QPointF

transformation from map coordinates to screen coordinates

Parameters

point (QgsPointXY) –

Return type

QPointF

toMapCoordinates(self, point: QPoint) → QgsPointXY

transformation from screen coordinates to map coordinates

Parameters

point (QPoint) –

Return type

QgsPointXY

updateCanvas(self)

schedules map canvas for repaint

updateMicroFocus()
updatePosition(self)

called on changed extent or resize event to update position of the item

wheelEvent()