Class: QgsMapOverviewCanvas

class qgis.gui.QgsMapOverviewCanvas

Bases: PyQt5.QtWidgets.QWidget

A widget that displays an overview map.

Enums

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
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

Signals

Attributes

actionEvent()
changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
destinationCrsChanged(self)

Should be called when the canvas destination CRS is changed

destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
drawExtentRect(self)

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

dropEvent()
enableAntiAliasing(self, flag: bool)
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
layerRepaintRequested(self, deferred: bool = False)

Triggered when a layer in the overview requests a repaint.

layers(self) → List[QgsMapLayer]

Returns list of layers visible in the overview

leaveEvent()
mapRenderingFinished(self)
metric()
mouseDoubleClickEvent()
mouseMoveEvent(self, e: QMouseEvent)

Overridden mouse move event

mousePressEvent(self, e: QMouseEvent)

Overridden mouse press event

mouseReleaseEvent(self, e: QMouseEvent)

Overridden mouse release event

moveEvent()
nativeEvent()
paintEvent(self, pe: QPaintEvent)

Overridden paint event

receivers()
refresh(self)

renders overview and updates panning widget

resizeEvent(self, e: QResizeEvent)

Overridden resize event

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

changes background color

setLayers(self, layers: Iterable[QgsMapLayer])

updates layer set for overview

sharedPainter()
showEvent(self, e: QShowEvent)

Overridden show event

tabletEvent()
timerEvent()
transformContextChanged(self)

Called when the canvas transform context is changed

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

called when panning to reflect mouse movement

wheelEvent()