Class: QgsMapToolExtent

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

Class Hierarchy

Base classes

QgsMapTool	Abstract base class for all map tools.
QObject

class qgis.gui.QgsMapToolExtent

Bases: QgsMapTool

__init__(canvas: QgsMapCanvas | None)

constructor

Parameters:

canvas (Optional[QgsMapCanvas])

clearRubberBand(self)

Removes the tool’s rubber band from the canvas.

Added in version 3.20.

extent(self) → QgsRectangle

Returns the current extent drawn onto the canvas.

Return type:

QgsRectangle

signal extentChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

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

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