QgsMapOverviewCanvas class

A widget that displays an overview map.

Public functions

auto layers() const -> QList<QgsMapLayer*>
Returns list of layers visible in the overview.
void refresh()
renders overview and updates panning widget
void setBackgroundColor(const QColor& color)
changes background color
void setLayers(const QList<QgsMapLayer*>& layers)
updates layer set for overview

Protected functions

void destinationCrsChanged()
Should be called when the canvas destination CRS is changed.
void drawExtentRect()
used for overview canvas to reflect changed extent in main map canvas
void mouseMoveEvent(QMouseEvent* e) override
Overridden mouse move event.
void mousePressEvent(QMouseEvent* e) override
Overridden mouse press event.
void mouseReleaseEvent(QMouseEvent* e) override
Overridden mouse release event.
void paintEvent(QPaintEvent* pe) override
Overridden paint event.
void resizeEvent(QResizeEvent* e) override
Overridden resize event.
void showEvent(QShowEvent* e) override
Overridden show event.
void transformContextChanged()
Called when the canvas transform context is changed.
void updatePanningWidget(QPoint pos)
called when panning to reflect mouse movement

Protected slots

void layerRepaintRequested(bool deferred = false)
Triggered when a layer in the overview requests a repaint.

Protected variables

QgsMapRendererQImageJob* mJob
for rendering overview
QgsMapCanvas* mMapCanvas
main map canvas - used to get/set extent
QPoint mPanningCursorOffset
position of cursor inside panning widget
QgsPanningWidget* mPanningWidget
widget for panning map in overview
QPixmap mPixmap
pixmap where the map is stored
QgsMapSettings mSettings
map settings used for rendering of the overview map