Class: QgsMapOverviewCanvas

A widget that displays an overview map.

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Methods

destinationCrsChanged	Should be called when the canvas destination CRS is changed
drawExtentRect	used for overview canvas to reflect changed extent in main map canvas
enableAntiAliasing
layerRepaintRequested	Triggered when a layer in the overview requests a repaint.
layers	Returns list of layers visible in the overview
mapRenderingFinished
mouseMoveEvent	Overridden mouse move event
mousePressEvent	Overridden mouse press event
mouseReleaseEvent	Overridden mouse release event
paintEvent	Overridden paint event
refresh	renders overview and updates panning widget
resizeEvent	Overridden resize event
setBackgroundColor	changes background color
setLayers	updates layer set for overview
showEvent	Overridden show event
transformContextChanged	Called when the canvas transform context is changed
updateFullExtent
updatePanningWidget	called when panning to reflect mouse movement
wheelEvent	Overridden mouse release event

class qgis.gui.QgsMapOverviewCanvas

Bases: QWidget

destinationCrsChanged(self)

Should be called when the canvas destination CRS is changed

drawExtentRect(self)

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

enableAntiAliasing(self, flag: bool)

Parameters:

flag (bool)

layerRepaintRequested(self, deferred: bool = False)

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)

mouseMoveEvent(self, e: QMouseEvent | None)

Overridden mouse move event

Parameters:

e (Optional[QMouseEvent])

mousePressEvent(self, e: QMouseEvent | None)

Overridden mouse press event

Parameters:

e (Optional[QMouseEvent])

mouseReleaseEvent(self, e: QMouseEvent | None)

Overridden mouse release event

Parameters:

e (Optional[QMouseEvent])

paintEvent(self, pe: QPaintEvent | None)

Overridden paint event

Parameters:

pe (Optional[QPaintEvent])

refresh(self)

renders overview and updates panning widget

resizeEvent(self, e: QResizeEvent | None)

Overridden resize event

Parameters:

e (Optional[QResizeEvent])

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

changes background color

Parameters:

color (Union[QColor, Qt.GlobalColor])

setLayers(self, layers: Iterable[QgsMapLayer])

updates layer set for overview

Parameters:

layers (Iterable[QgsMapLayer])

showEvent(self, e: QShowEvent | None)

Overridden show event

Parameters:

e (Optional[QShowEvent])

transformContextChanged(self)

Called when the canvas transform context is changed

updateFullExtent(self)

updatePanningWidget(self, pos: QPoint)

called when panning to reflect mouse movement

Parameters:

pos (QPoint)

wheelEvent(self, e: QWheelEvent | None)

Overridden mouse release event

Parameters:

e (Optional[QWheelEvent])