Class: QgsMapOverviewCanvas

class qgis.gui.QgsMapOverviewCanvas

Bases: PyQt5.QtWidgets.QWidget

A widget that displays an overview map.

Methods

actionEvent

changeEvent

childEvent

closeEvent

connectNotify

contextMenuEvent

create

customEvent

destinationCrsChanged

Should be called when the canvas destination CRS is changed

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

drawExtentRect

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

dropEvent

enableAntiAliasing

param flag

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

layerRepaintRequested

Triggered when a layer in the overview requests a repaint.

layers

Returns list of layers visible in the overview

leaveEvent

mapRenderingFinished

metric

mouseDoubleClickEvent

mouseMoveEvent

Overridden mouse move event

mousePressEvent

Overridden mouse press event

mouseReleaseEvent

Overridden mouse release event

moveEvent

nativeEvent

paintEvent

Overridden paint event

receivers

refresh

renders overview and updates panning widget

resizeEvent

Overridden resize event

sender

senderSignalIndex

setBackgroundColor

changes background color

setLayers

updates layer set for overview

sharedPainter

showEvent

Overridden show event

tabletEvent

timerEvent

transformContextChanged

Called when the canvas transform context is changed

updateFullExtent

updateMicroFocus

updatePanningWidget

called when panning to reflect mouse movement

wheelEvent

actionEvent(self, QActionEvent)
changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
destinationCrsChanged(self)

Should be called when the canvas destination CRS is changed

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
drawExtentRect(self)

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

dropEvent(self, QDropEvent)
enableAntiAliasing(self, flag: bool)
Parameters

flag (bool) –

enterEvent(self, QEvent)
event(self, QEvent)bool
focusInEvent(self, QFocusEvent)
focusNextChild(self)bool
focusNextPrevChild(self, bool)bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self)bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
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]

leaveEvent(self, QEvent)
mapRenderingFinished(self)
metric(self, QPaintDevice.PaintDeviceMetric)int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, e: QMouseEvent)

Overridden mouse move event

Parameters

e (QMouseEvent) –

mousePressEvent(self, e: QMouseEvent)

Overridden mouse press event

Parameters

e (QMouseEvent) –

mouseReleaseEvent(self, e: QMouseEvent)

Overridden mouse release event

Parameters

e (QMouseEvent) –

moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
paintEvent(self, pe: QPaintEvent)

Overridden paint event

Parameters

pe (QPaintEvent) –

receivers(self, PYQT_SIGNAL)int
refresh(self)

renders overview and updates panning widget

resizeEvent(self, e: QResizeEvent)

Overridden resize event

Parameters

e (QResizeEvent) –

sender(self)QObject
senderSignalIndex(self)int
setBackgroundColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])

changes background color

Parameters

color (Union[QColor) –

setLayers(self, layers: Iterable[QgsMapLayer])

updates layer set for overview

Parameters

layers (Iterable[QgsMapLayer]) –

sharedPainter(self)QPainter
showEvent(self, e: QShowEvent)

Overridden show event

Parameters

e (QShowEvent) –

tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
transformContextChanged(self)

Called when the canvas transform context is changed

updateFullExtent(self)
updateMicroFocus(self)
updatePanningWidget(self, pos: QPoint)

called when panning to reflect mouse movement

Parameters

pos (QPoint) –

wheelEvent(self, QWheelEvent)