Class: QgsMapOverviewCanvas

A widget that displays an overview map.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsMapOverviewCanvas

Base classes

QWidget

QObject

QPaintDevice
class qgis.gui.QgsMapOverviewCanvas[source]

Bases: QWidget

destinationCrsChanged(self)[source]

Should be called when the canvas destination CRS is changed

drawExtentRect(self)[source]

used for overview canvas to reflect changed extent in main map canvas

enableAntiAliasing(self, flag: bool)[source]
Parameters:

flag (bool)

layerRepaintRequested(self, deferred: bool = False)[source]

Triggered when a layer in the overview requests a repaint.

Parameters:

deferred (bool = False)

layers(self) → List[QgsMapLayer]

Returns list of layers visible in the overview

Return type:

List[QgsMapLayer]

mapRenderingFinished(self)[source]
virtual mouseMoveEvent(self, e: QMouseEvent | None)[source]

Overridden mouse move event

Parameters:

e (Optional[QMouseEvent])

virtual mousePressEvent(self, e: QMouseEvent | None)[source]

Overridden mouse press event

Parameters:

e (Optional[QMouseEvent])

virtual mouseReleaseEvent(self, e: QMouseEvent | None)[source]

Overridden mouse release event

Parameters:

e (Optional[QMouseEvent])

virtual paintEvent(self, pe: QPaintEvent | None)[source]

Overridden paint event

Parameters:

pe (Optional[QPaintEvent])

refresh(self)[source]

renders overview and updates panning widget

virtual resizeEvent(self, e: QResizeEvent | None)[source]

Overridden resize event

Parameters:

e (Optional[QResizeEvent])

setBackgroundColor(self, color: QColor | Qt.GlobalColor)[source]

changes background color

Parameters:

color (Union[QColor, Qt.GlobalColor])

setLayers(self, layers: Iterable[QgsMapLayer])[source]

updates layer set for overview

Parameters:

layers (Iterable[QgsMapLayer])

virtual showEvent(self, e: QShowEvent | None)[source]

Overridden show event

Parameters:

e (Optional[QShowEvent])

transformContextChanged(self)[source]

Called when the canvas transform context is changed

updateFullExtent(self)[source]
updatePanningWidget(self, pos: QPoint)[source]

called when panning to reflect mouse movement

Parameters:

pos (QPoint)

virtual wheelEvent(self, e: QWheelEvent | None)[source]

Overridden mouse release event

Parameters:

e (Optional[QWheelEvent])