Class: QgsMapToolEdit

class qgis.gui.QgsMapToolEdit

Bases: QgsMapTool

Base class for map tools that edit vector geometry

Methods

addTopologicalPoints	Adds vertices to other features to keep topology up to date, e.g.
childEvent
connectNotify
createGeometryRubberBand	param geometryType
createRubberBand	Creates a rubber band with the color/line width from the QGIS settings.
currentVectorLayer	Returns the current vector layer of the map canvas or 0
customEvent
defaultZValue	Returns default Z value Use for set Z coordinate to new vertex for 2.5d geometries
digitizingFillColor	Returns fill color for rubber bands (from global settings)
digitizingStrokeColor	Returns stroke color for rubber bands (from global settings)
digitizingStrokeWidth	Returns stroke width for rubber bands (from global settings)
disconnectNotify
flags	rtype QgsMapTool.Flags
isSignalConnected
notifyNotEditableLayer	Display a timed message bar noting the active vector layer is not editable.
notifyNotVectorLayer	Display a timed message bar noting the active layer is not vector.
receivers
sender
senderSignalIndex
timerEvent
toCanvasCoordinates
toLayerCoordinates
toMapCoordinates
toMapCoordinatesV2

addTopologicalPoints(self, geom: Iterable[QgsPointXY]) → int

Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons.

Parameters

geom (Iterable[QgsPointXY]) – list of points (in layer coordinate system)

Return type

int

Returns

0 in case of success

childEvent()

connectNotify()

createGeometryRubberBand(self, geometryType: QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry, alternativeBand: bool = False) → QgsGeometryRubberBand

Parameters

• geometryType (QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry) –

• alternativeBand (bool = False) –

Return type

QgsGeometryRubberBand

createRubberBand(self, geometryType: QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry, alternativeBand: bool = False) → QgsRubberBand

Creates a rubber band with the color/line width from the QGIS settings. The caller takes ownership of the returned object

Parameters

• geometryType (QgsWkbTypes.GeometryType = QgsWkbTypes.LineGeometry) –

• alternativeBand (bool = False) – if true, rubber band will be set with more transparency and a dash pattern. default is false.

Return type

QgsRubberBand

currentVectorLayer(self) → QgsVectorLayer

Returns the current vector layer of the map canvas or 0

Return type

QgsVectorLayer

customEvent()

defaultZValue(self) → float

Returns default Z value Use for set Z coordinate to new vertex for 2.5d geometries

Return type

float

digitizingFillColor() → QColor

Returns fill color for rubber bands (from global settings)

Return type

QColor

digitizingStrokeColor() → QColor

Returns stroke color for rubber bands (from global settings)

Return type

QColor

digitizingStrokeWidth() → int

Returns stroke width for rubber bands (from global settings)

Return type

int

disconnectNotify()

flags(self) → QgsMapTool.Flags

Return type

QgsMapTool.Flags

isSignalConnected()

notifyNotEditableLayer(self)

Display a timed message bar noting the active vector layer is not editable.

notifyNotVectorLayer(self)

Display a timed message bar noting the active layer is not vector.

receivers()

sender()

senderSignalIndex()

timerEvent()

toCanvasCoordinates()

toLayerCoordinates()

toMapCoordinates()

toMapCoordinatesV2()