Subgroup: Map

Class: QgsMapCanvasItem

class qgis.gui.QgsMapCanvasItem

Bases: PyQt5.QtWidgets.QGraphicsItem

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

Methods

acceptDrops
acceptHoverEvents
acceptTouchEvents
acceptedMouseButtons
advance
boundingRect
boundingRegion
boundingRegionGranularity
cacheMode
childItems
childrenBoundingRect
clearFocus
clipPath
collidesWithItem
collidesWithPath
collidingItems
commonAncestorItem
contains
contextMenuEvent
cursor
data
deviceTransform
dragEnterEvent
dragLeaveEvent
dragMoveEvent
dropEvent
effectiveOpacity
ensureVisible ensureVisible(self, float, float, float, float, xMargin: int = 50, yMargin: int = 50)
filtersChildEvents
flags
focusInEvent
focusItem
focusOutEvent
focusProxy
grabKeyboard
grabMouse
graphicsEffect
group
hasCursor
hasFocus
hide
hoverEnterEvent
hoverLeaveEvent
hoverMoveEvent
inputMethodEvent
inputMethodHints
inputMethodQuery
installSceneEventFilter
isActive
isAncestorOf
isBlockedByModalPanel
isClipped
isEnabled
isObscured isObscured(self, float, float, float, float) -> bool
isObscuredBy
isPanel
isSelected
isUnderMouse
isVisible
isVisibleTo
isWidget
isWindow
itemChange
itemTransform
keyPressEvent
keyReleaseEvent
mapFromItem mapFromItem(self, QGraphicsItem, QRectF) -> QPolygonF
mapFromParent mapFromParent(self, QRectF) -> QPolygonF
mapFromScene mapFromScene(self, QRectF) -> QPolygonF
mapRectFromItem mapRectFromItem(self, QGraphicsItem, float, float, float, float) -> QRectF
mapRectFromParent mapRectFromParent(self, float, float, float, float) -> QRectF
mapRectFromScene mapRectFromScene(self, float, float, float, float) -> QRectF
mapRectToItem mapRectToItem(self, QGraphicsItem, float, float, float, float) -> QRectF
mapRectToParent mapRectToParent(self, float, float, float, float) -> QRectF
mapRectToScene mapRectToScene(self, float, float, float, float) -> QRectF
mapToItem mapToItem(self, QGraphicsItem, QRectF) -> QPolygonF
mapToParent mapToParent(self, QRectF) -> QPolygonF
mapToScene mapToScene(self, QRectF) -> QPolygonF
mouseDoubleClickEvent
mouseMoveEvent
mousePressEvent
mouseReleaseEvent
moveBy
opacity
opaqueArea
paint function to be implemented by derived classes
panel
panelModality
parentItem
parentObject
parentWidget
pos
prepareGeometryChange
rect returns canvas item rectangle in map units
removeSceneEventFilter
resetTransform
rotation
scale
scene
sceneBoundingRect
sceneEvent
sceneEventFilter
scenePos
sceneTransform
scroll
setAcceptDrops
setAcceptHoverEvents
setAcceptTouchEvents
setAcceptedMouseButtons
setActive
setBoundingRegionGranularity
setCacheMode
setCursor
setData
setEnabled
setFiltersChildEvents
setFlag
setFlags
setFocus
setFocusProxy
setGraphicsEffect
setGroup
setInputMethodHints
setOpacity
setPanelModality
setParentItem
setPos setPos(self, float, float)
setRect sets canvas item rectangle in map units
setRenderContextVariables Sets render context parameters
setRotation
setScale
setSelected
setToolTip
setTransform
setTransformOriginPoint setTransformOriginPoint(self, float, float)
setTransformations
setVisible
setX
setY
setZValue
shape
show
stackBefore
toCanvasCoordinates transformation from map coordinates to screen coordinates
toGraphicsObject
toMapCoordinates transformation from screen coordinates to map coordinates
toolTip
topLevelItem
topLevelWidget
transform
transformOriginPoint
transformations
type
ungrabKeyboard
ungrabMouse
unsetCursor
update update(self, float, float, float, float)
updateCanvas schedules map canvas for repaint
updateMicroFocus
updatePosition called on changed extent or resize event to update position of the item
wheelEvent
window
x
y
zValue

Attributes

DeviceCoordinateCache
ItemAcceptsInputMethod
ItemChildAddedChange
ItemChildRemovedChange
ItemClipsChildrenToShape
ItemClipsToShape
ItemContainsChildrenInShape
ItemCoordinateCache
ItemCursorChange
ItemCursorHasChanged
ItemDoesntPropagateOpacityToChildren
ItemEnabledChange
ItemEnabledHasChanged
ItemFlagsChange
ItemFlagsHaveChanged
ItemHasNoContents
ItemIgnoresParentOpacity
ItemIgnoresTransformations
ItemIsFocusable
ItemIsMovable
ItemIsPanel
ItemIsSelectable
ItemMatrixChange
ItemNegativeZStacksBehindParent
ItemOpacityChange
ItemOpacityHasChanged
ItemParentChange
ItemParentHasChanged
ItemPositionChange
ItemPositionHasChanged
ItemRotationChange
ItemRotationHasChanged
ItemScaleChange
ItemScaleHasChanged
ItemSceneChange
ItemSceneHasChanged
ItemScenePositionHasChanged
ItemSelectedChange
ItemSelectedHasChanged
ItemSendsGeometryChanges
ItemSendsScenePositionChanges
ItemStacksBehindParent
ItemToolTipChange
ItemToolTipHasChanged
ItemTransformChange
ItemTransformHasChanged
ItemTransformOriginPointChange
ItemTransformOriginPointHasChanged
ItemUsesExtendedStyleOption
ItemVisibleChange
ItemVisibleHasChanged
ItemZValueChange
ItemZValueHasChanged
NoCache
NonModal
PanelModal
SceneModal
Type
UserType
boundingRect(self) → 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)

prepareGeometryChange()
rect(self) → QgsRectangle

returns canvas item rectangle in map units

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

sets canvas item rectangle in map units

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 *

toCanvasCoordinates(self, point: QgsPointXY) → QPointF

transformation from map coordinates to screen coordinates

toMapCoordinates(self, point: QPoint) → QgsPointXY

transformation from screen coordinates to map coordinates

updateCanvas(self)

schedules map canvas for repaint

updateMicroFocus()
updatePosition(self)

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

wheelEvent()