Class: QgsMapToolExtent¶
- class qgis.gui.QgsMapToolExtent¶
Bases:
QgsMapTool
A map tool that emits an extent from a rectangle drawn onto the map canvas.
New in version 3.0.
QgsMapToolExtent(canvas:
QgsMapCanvas
) constructorMethods
- param e
- param e
- param e
Removes the tool's rubber band from the canvas.
Returns the current extent drawn onto the canvas.
- rtype
QgsMapTool.Flags
Returns the current fixed aspect ratio to be used when dragging extent onto the canvas.
Sets a fixed aspect ratio to be used when dragging extent onto the canvas.
Sets the tool's
name
.Transforms a
point
from map coordinates to screen coordinates.Transforms a
point
from screen coordinates tolayer
coordinates.Transforms a
point
from screen coordinates to map coordinates.Transforms a
point
fromlayer
coordinates to map coordinates (which is different in case reprojection is used).Signals
signal emitted on extent change [signal]
- activate(self)¶
- canvasMoveEvent(self, e: QgsMapMouseEvent)¶
- Parameters
e (QgsMapMouseEvent) –
- canvasPressEvent(self, e: QgsMapMouseEvent)¶
- Parameters
e (QgsMapMouseEvent) –
- canvasReleaseEvent(self, e: QgsMapMouseEvent)¶
- Parameters
e (QgsMapMouseEvent) –
- childEvent(self, QChildEvent)¶
- clearRubberBand(self)¶
Removes the tool’s rubber band from the canvas.
New in version 3.20.
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- deactivate(self)¶
- disconnectNotify(self, QMetaMethod)¶
- extent(self) QgsRectangle ¶
Returns the current extent drawn onto the canvas.
- Return type
- extentChanged¶
signal emitted on extent change [signal]
- Parameters
extent (QgsRectangle) –
- flags(self) QgsMapTool.Flags ¶
- Return type
- isSignalConnected(self, QMetaMethod) bool ¶
- 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(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- 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
- setToolName(self, name: str)¶
Sets the tool’s
name
.See also
toolName()
New in version 3.20.
- timerEvent(self, QTimerEvent)¶
- toCanvasCoordinates(self, point: QgsPointXY) QPoint ¶
Transforms a
point
from map coordinates to screen coordinates.
- toLayerCoordinates(self, layer: QgsMapLayer, point: QPoint) QgsPointXY ¶
Transforms a
point
from screen coordinates tolayer
coordinates.toLayerCoordinates(self, layer:
QgsMapLayer
, point:QgsPointXY
) -> QgsPointXY Transforms apoint
from map coordinates tolayer
coordinates.toLayerCoordinates(self, layer:
QgsMapLayer
, rect:QgsRectangle
) -> QgsRectangle Transforms arect
from map coordinates tolayer
coordinates.
- toMapCoordinates(self, point: QPoint) QgsPointXY ¶
Transforms a
point
from screen coordinates to map coordinates.toMapCoordinates(self, layer:
QgsMapLayer
, point:QgsPointXY
) -> QgsPointXY Transforms apoint
fromlayer
coordinates to map coordinates (which is different in case reprojection is used).
- toMapCoordinatesV2(self, layer: QgsMapLayer, point: QgsPoint) QgsPoint ¶
Transforms a
point
fromlayer
coordinates to map coordinates (which is different in case reprojection is used).Note
This method is available in the Python bindings as toMapCoordinatesV2.