Class: QgsMapToolPan¶

A map tool for panning the map.

Class Hierarchy¶

Base classes¶

`QgsMapTool`	Abstract base class for all map tools.
QObject

Methods

isDragging

Returns True if a drag operation is in progress.

Signals

panDistanceBearingChanged

Emitted whenever the distance or bearing of an in-progress panning operation is changed.

class qgis.gui.QgsMapToolPan[source]¶

Bases: QgsMapTool

__init__(canvas: QgsMapCanvas | None)

constructor

Parameters:: canvas (Optional[QgsMapCanvas])

isDragging(self) → bool[source]¶

Returns True if a drag operation is in progress.

Added in version 3.12.

Return type:: bool

signal panDistanceBearingChanged(distance: float, unit: Qgis.DistanceUnit, bearing: float)[source]¶

Emitted whenever the distance or bearing of an in-progress panning operation is changed.

This signal will be emitted during a pan operation as the user moves the map, giving the total distance and bearing between the map position at the start of the pan and the current pan position.

Added in version 3.12.

Parameters:

distance (float)
unit (Qgis.DistanceUnit)
bearing (float)