Class: QgsMapToolExtent

class qgis.gui.QgsMapToolExtent(canvas: QgsMapCanvas)

Bases: QgsMapTool

constructor

A map tool that emits an extent from a rectangle drawn onto the map canvas.

New in version 3.0.

Parameters

canvas

activate(self)
canvasMoveEvent(self, e: QgsMapMouseEvent)
Parameters

e (QgsMapMouseEvent) –

canvasPressEvent(self, e: QgsMapMouseEvent)
Parameters

e (QgsMapMouseEvent) –

canvasReleaseEvent(self, e: QgsMapMouseEvent)
Parameters

e (QgsMapMouseEvent) –

childEvent()
connectNotify()
customEvent()
deactivate(self)
disconnectNotify()
extent(self) → QgsRectangle

Returns the current extent drawn onto the canvas.

Return type

QgsRectangle

extentChanged

signal emitted on extent change [signal]

flags(self) → QgsMapTool.Flags
Return type

QgsMapTool.Flags

isSignalConnected()
ratio(self) → QSize

Returns the current fixed aspect ratio to be used when dragging extent onto the canvas. If the aspect ratio isn’t fixed, the width and height will be set to zero.

Return type

QSize

receivers()
sender()
senderSignalIndex()
setRatio(self, ratio: QSize)

Sets a fixed aspect ratio to be used when dragging extent onto the canvas. To unset a fixed aspect ratio, set the width and height to zero.

Parameters

ratio (QSize) – aspect ratio’s width and height

timerEvent()
toCanvasCoordinates()
toLayerCoordinates()
toMapCoordinates()
toMapCoordinatesV2()