Class: QgsMapTool

class qgis.gui.QgsMapTool(canvas: QgsMapCanvas)

Bases: PyQt5.QtCore.QObject

constructor takes map canvas as a parameter

Abstract base class for all map tools. Map tools are user interactive tools for manipulating the map canvas. For example map pan and zoom features are implemented as map tools.

Parameters

canvas

AllowZoomRect = 8
EditTool = 4
class Flag

Bases: int

class Flags

Bases: sip.wrapper

QgsMapTool.Flags(Union[QgsMapTool.Flags, QgsMapTool.Flag]) QgsMapTool.Flags(QgsMapTool.Flags)

Transient = 2
action(self) → QAction

Returns associated action with map tool or None if no action is associated

Return type

QAction

activate(self)

called when set as currently active map tool

activated

signal emitted once the map tool is activated [signal]

button(self) → QAbstractButton

Returns associated button with map tool or None if no button is associated

Return type

QAbstractButton

canvas(self) → QgsMapCanvas

returns pointer to the tool’s map canvas

Return type

QgsMapCanvas

canvasDoubleClickEvent(self, e: QgsMapMouseEvent)

Mouse double-click event for overriding. Default implementation does nothing.

Parameters

e (QgsMapMouseEvent) –

canvasMoveEvent(self, e: QgsMapMouseEvent)

Mouse move event for overriding. Default implementation does nothing.

Parameters

e (QgsMapMouseEvent) –

canvasPressEvent(self, e: QgsMapMouseEvent)

Mouse press event for overriding. Default implementation does nothing.

Parameters

e (QgsMapMouseEvent) –

canvasReleaseEvent(self, e: QgsMapMouseEvent)

Mouse release event for overriding. Default implementation does nothing.

Parameters

e (QgsMapMouseEvent) –

childEvent()
clean(self)

convenient method to clean members

connectNotify()
customEvent()
deactivate(self)

called when map tool is being deactivated

deactivated

signal emitted once the map tool is deactivated [signal]

disconnectNotify()
flags(self) → QgsMapTool.Flags

Returns the flags for the map tool.

New in version 2.16.

Return type

QgsMapTool.Flags

gestureEvent(self, e: QGestureEvent) → bool

gesture event for overriding. Default implementation does nothing.

Parameters

e (QGestureEvent) –

Return type

bool

isActive(self) → bool

Returns if the current map tool active on the map canvas

New in version 3.4.

Return type

bool

isSignalConnected()
keyPressEvent(self, e: QKeyEvent)

Key event for overriding. Default implementation does nothing.

Parameters

e (QKeyEvent) –

keyReleaseEvent(self, e: QKeyEvent)

Key event for overriding. Default implementation does nothing.

Parameters

e (QKeyEvent) –

messageDiscarded

emit signal to clear previous message [signal]

messageEmitted

emit a message [signal]

Parameters
  • message (str) –

  • a1 (Qgis.MessageLevel = Qgis.Info) –

receivers()
searchRadiusMM() → float

Gets search radius in mm. Used by identify, tip etc. The values is currently set in identify tool options (move somewhere else?) and defaults to Qgis.DEFAULT_SEARCH_RADIUS_MM.

New in version 2.3.

Return type

float

searchRadiusMU(context: QgsRenderContext) → float

Gets search radius in map units for given context. Used by identify, tip etc. The values is calculated from searchRadiusMM().

New in version 2.3.

searchRadiusMU(canvas: QgsMapCanvas) -> float Gets search radius in map units for given canvas. Used by identify, tip etc. The values is calculated from searchRadiusMM().

New in version 2.3.

Parameters

context (QgsRenderContext) –

Return type

float

sender()
senderSignalIndex()
setAction(self, action: QAction)

Use this to associate a QAction to this maptool. Then when the setMapTool method of mapcanvas is called the action state will be set to on. Usually this will cause e.g. a toolbutton to appear pressed in and the previously used toolbutton to pop out. *

Parameters

action (QAction) –

setButton(self, button: QAbstractButton)

Use this to associate a button to this maptool. It has the same meaning as setAction() function except it works with a button instead of an QAction. *

Parameters

button (QAbstractButton) –

setCursor(self, cursor: Union[QCursor, Qt.CursorShape])

Sets a user defined cursor

Parameters

cursor (Union[QCursor) –

timerEvent()
toCanvasCoordinates(self, point: QgsPointXY) → QPoint

transformation from map coordinates to screen coordinates

Parameters

point (QgsPointXY) –

Return type

QPoint

toLayerCoordinates(self, layer: QgsMapLayer, point: QPoint) → QgsPointXY

transformation from screen coordinates to layer’s coordinates

toLayerCoordinates(self, layer: QgsMapLayer, point: QgsPointXY) -> QgsPointXY transformation from map coordinates to layer’s coordinates

toLayerCoordinates(self, layer: QgsMapLayer, rect: QgsRectangle) -> QgsRectangle trnasformation of the rect from map coordinates to layer’s coordinates

Parameters
Return type

QgsPointXY

toMapCoordinates(self, point: QPoint) → QgsPointXY

transformation from screen coordinates to map coordinates

toMapCoordinates(self, layer: QgsMapLayer, point: QgsPointXY) -> QgsPointXY transformation from layer’s coordinates to map coordinates (which is different in case reprojection is used)

Parameters

point (QPoint) –

Return type

QgsPointXY

toMapCoordinatesV2(self, layer: QgsMapLayer, point: QgsPoint) → QgsPoint

transformation from layer’s coordinates to map coordinates (which is different in case reprojection is used)

Note

available in Python bindings as toMapCoordinatesV2

Parameters
Return type

QgsPoint

toolName(self) → str

Emit map tool changed with the old tool

New in version 2.3.

Return type

str

wheelEvent(self, e: QWheelEvent)

Mouse wheel event for overriding. Default implementation does nothing.

Parameters

e (QWheelEvent) –