Class: QgsCoordinateBoundsPreviewMapWidget

class qgis.gui.QgsCoordinateBoundsPreviewMapWidget

Bases: QgsMapCanvas

A widget for showing the bounds of a rectangular region on an interactive map.

New in version 3.8.1.

QgsCoordinateBoundsPreviewMapWidget(parent: QWidget = None) Constructor for QgsCoordinateBoundsPreviewMapWidget.

Methods

actionEvent

canvasRect

Returns the current canvas bounds rectangle shown in the map.

changeEvent

childEvent

closeEvent

connectNotify

contextMenuEvent

create

customEvent

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

drawBackground

drawForeground

drawFrame

dropEvent

enterEvent

event

eventFilter

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

initStyleOption

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveCanvasContents

called when panning is in action, reset indicates end of panning

moveEvent

nativeEvent

paintEvent

receivers

resizeEvent

scrollContentsBy

sender

senderSignalIndex

setCanvasRect

Sets the canvas bounds rectangle for the bounds overview map.

setPreviewRect

Sets the “preview” rectangle for the bounds overview map.

setViewportMargins

setupViewport

sharedPainter

showEvent

tabletEvent

timerEvent

updateCanvasItemPositions

called on resize or changed extent to notify canvas items to change their rectangle

updateMicroFocus

viewportEvent

viewportMargins

viewportSizeHint

wheelEvent

actionEvent(self, QActionEvent)
canvasRect(self)QgsRectangle

Returns the current canvas bounds rectangle shown in the map.

See also

setCanvasRect()

Return type

QgsRectangle

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)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, e: QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
drawBackground(self, QPainter, QRectF)
drawForeground(self, QPainter, QRectF)
drawFrame(self, QPainter)
dropEvent(self, event: QDropEvent)
enterEvent(self, QEvent)
event(self, e: QEvent)bool
eventFilter(self, QObject, QEvent)bool
focusInEvent(self, QFocusEvent)
focusNextChild(self)bool
focusNextPrevChild(self, bool)bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self)bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
initStyleOption(self, QStyleOptionFrame)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, e: QKeyEvent)
keyReleaseEvent(self, e: QKeyEvent)
leaveEvent(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric)int
mouseDoubleClickEvent(self, e: QMouseEvent)
mouseMoveEvent(self, e: QMouseEvent)
mousePressEvent(self, e: QMouseEvent)
mouseReleaseEvent(self, e: QMouseEvent)
moveCanvasContents(self, reset: bool = False)

called when panning is in action, reset indicates end of panning

moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
paintEvent(self, e: QPaintEvent)
receivers(self, PYQT_SIGNAL)int
resizeEvent(self, e: QResizeEvent)
QgsCoordinateBoundsPreviewMapWidget.scrollContentsBy(self, int, int)
sender(self)QObject
senderSignalIndex(self)int
setCanvasRect(self, rect: QgsRectangle)

Sets the canvas bounds rectangle for the bounds overview map.

Must be in EPSG:4326 coordinate reference system.

See also

canvasRect()

Parameters

rect (QgsRectangle) –

setPreviewRect(self, rect: QgsRectangle)

Sets the “preview” rectangle for the bounds overview map. Must be in EPSG:4326 coordinate reference system.

Parameters

rect (QgsRectangle) –

QgsCoordinateBoundsPreviewMapWidget.setViewportMargins(self, int, int, int, int)
setViewportMargins(self, QMargins)None
setupViewport(self, QWidget)
sharedPainter(self)QPainter
showEvent(self, event: QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateCanvasItemPositions(self)

called on resize or changed extent to notify canvas items to change their rectangle

updateMicroFocus(self)
viewportEvent(self, event: QEvent)bool
viewportMargins(self)QMargins
viewportSizeHint(self)QSize
wheelEvent(self, e: QWheelEvent)