napari.qt.QtViewer

class napari.qt.QtViewer(viewer: ViewerModel, show_welcome_screen: bool = False)[source]

Bases: PyQt5.QtWidgets.QSplitter

Qt view for the napari Viewer model.

Parameters
  • viewer (napari.components.ViewerModel) – Napari viewer containing the rendered scene, layers, and controls.

  • show_welcome_screen (bool, optional) – Flag to show a welcome message when no layers are present in the canvas. Default is False.

canvas

Canvas for rendering the current view.

Type

vispy.scene.SceneCanvas

console

IPython console terminal integrated into the napari GUI.

Type

QtConsole

controls

Qt view for GUI controls.

Type

QtLayerControlsContainer

dims

Dimension sliders; Qt View for Dims model.

Type

napari.qt_dims.QtDims

dockConsole

QWidget wrapped in a QDockWidget with forwarded viewer events.

Type

QtViewerDockWidget

dockLayerControls

QWidget wrapped in a QDockWidget with forwarded viewer events.

Type

QtViewerDockWidget

dockLayerList

QWidget wrapped in a QDockWidget with forwarded viewer events.

Type

QtViewerDockWidget

layerButtons

Button controls for napari layers.

Type

QtLayerButtons

layers

Qt view for LayerList controls.

Type

QtLayerList

layer_to_visual

Dictionary mapping napari layers with their corresponding vispy_layers.

Type

dict

view

View displayed by vispy canvas. Adds a vispy ViewBox as a child widget.

Type

vispy scene widget

viewer

Napari viewer containing the rendered scene, layers, and controls.

Type

napari.components.ViewerModel

viewerButtons

Button controls for the napari viewer.

Type

QtViewerButtons

Methods

acceptDrops(self)

accessibleDescription(self)

accessibleName(self)

actionEvent(self, QActionEvent)

actions(self)

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

addWidget(self, QWidget)

adjustSize(self)

autoFillBackground(self)

backgroundRole(self)

baseSize(self)

blockSignals(self, bool)

changeEvent(self, QEvent)

childAt(-> QWidget)

childEvent(self, QChildEvent)

children(self)

childrenCollapsible(self)

childrenRect(self)

childrenRegion(self)

clearFocus(self)

clearMask(self)

clipboard([flash])

Take a screenshot of the currently displayed screen and copy the image to the clipboard.

close(self)

closeEvent(event)

Cleanup and close.

closestLegalPosition(self, int, int)

colorCount(self)

connectNotify(self, QMetaMethod)

contentsMargins(self)

contentsRect(self)

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self)

count(self)

create(self[, window, initializeWindow, ...])

createHandle(self)

createWindowContainer(QWindow[, parent, flags])

cursor(self)

customEvent(self, QEvent)

deleteLater(self)

depth(self)

destroy(self[, destroyWindow, destroySubWindows])

devType(self)

devicePixelRatio(self)

devicePixelRatioF(self)

devicePixelRatioFScale()

disconnect(-> bool)

disconnectNotify(self, QMetaMethod)

dragEnterEvent(event)

Ignore event if not dragging & dropping a file or URL to open.

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

drawFrame(self, QPainter)

dropEvent(event)

Add local files and web URLS with drag and drop.

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self)

effectiveWinId(self)

ensurePolished(self)

enterEvent(self, QEvent)

event(self, QEvent)

eventFilter(self, QObject, QEvent)

find(PyQt5.sip.voidptr)

findChild(-> QObject)

findChildren(...)

focusInEvent(self, QFocusEvent)

focusNextChild(self)

focusNextPrevChild(self, bool)

focusOutEvent(self, QFocusEvent)

focusPolicy(self)

focusPreviousChild(self)

focusProxy(self)

focusWidget(self)

font(self)

fontInfo(self)

fontMetrics(self)

foregroundRole(self)

frameGeometry(self)

frameRect(self)

frameShadow(self)

frameShape(self)

frameSize(self)

frameStyle(self)

frameWidth(self)

geometry(self)

getContentsMargins(self)

getRange(self, int)

grab(self[, rectangle])

grabGesture(self, Qt.GestureType, flags, ...)

grabKeyboard(self)

grabMouse()

grabShortcut(self, Union[QKeySequence, ...)

graphicsEffect(self)

graphicsProxyWidget(self)

handle(self, int)

handleWidth(self)

hasFocus(self)

hasHeightForWidth(self)

hasMouseTracking(self)

hasTabletTracking(self)

height(self)

heightForWidth(self, int)

heightMM(self)

hide(self)

hideEvent(self, QHideEvent)

indexOf(self, QWidget)

inherits(self, str)

initPainter(self, QPainter)

initStyleOption(self, QStyleOptionFrame)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self)

inputMethodQuery(self, Qt.InputMethodQuery)

insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

insertWidget(self, int, QWidget)

installEventFilter(self, QObject)

isActiveWindow(self)

isAncestorOf(self, QWidget)

isCollapsible(self, int)

isEnabled(self)

isEnabledTo(self, QWidget)

isFullScreen(self)

isHidden(self)

isLeftToRight(self)

isMaximized(self)

isMinimized(self)

isModal(self)

isRightToLeft(self)

isSignalConnected(self, QMetaMethod)

isVisible(self)

isVisibleTo(self, QWidget)

isWidgetType(self)

isWindow(self)

isWindowModified(self)

isWindowType(self)

keyPressEvent(event)

Called whenever a key is pressed.

keyReleaseEvent(event)

Called whenever a key is released.

keyboardGrabber()

killTimer(self, int)

layout(self)

layoutDirection(self)

leaveEvent(self, QEvent)

lineWidth(self)

locale(self)

logicalDpiX(self)

logicalDpiY(self)

lower(self)

mapFrom(self, QWidget, QPoint)

mapFromGlobal(self, QPoint)

mapFromParent(self, QPoint)

mapTo(self, QWidget, QPoint)

mapToGlobal(self, QPoint)

mapToParent(self, QPoint)

mask(self)

maximumHeight(self)

maximumSize(self)

maximumWidth(self)

metaObject(self)

metric(self, QPaintDevice.PaintDeviceMetric)

midLineWidth(self)

minimumHeight(self)

minimumSize(self)

minimumSizeHint(self)

minimumWidth(self)

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber()

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move()

moveEvent(self, QMoveEvent)

moveSplitter(self, int, int)

moveToThread(self, QThread)

nativeEvent(self, Union[QByteArray, bytes, ...)

nativeParentWidget(self)

nextInFocusChain(self)

normalGeometry(self)

objectName(self)

on_draw(event)

Called whenever the canvas is drawn.

on_mouse_double_click(event)

Called whenever a mouse double-click happen on the canvas

on_mouse_move(event)

Called whenever mouse moves over canvas.

on_mouse_press(event)

Called whenever mouse pressed in canvas.

on_mouse_release(event)

Called whenever mouse released in canvas.

on_mouse_wheel(event)

Called whenever mouse wheel activated in canvas.

on_resize(event)

Called whenever canvas is resized.

opaqueResize(self)

orientation(self)

overrideWindowFlags(self, ...)

overrideWindowState(self, ...)

paintEngine(self)

paintEvent(self, QPaintEvent)

paintingActive(self)

palette(self)

parent(self)

parentWidget(self)

physicalDpiX(self)

physicalDpiY(self)

pos(self)

previousInFocusChain(self)

property(self, str)

pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal.

raise_(self)

receivers(self, PYQT_SIGNAL)

rect(self)

refresh(self)

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

render(, sourceRegion, flags, ...)

repaint(-> None  -> None)

replaceWidget(self, int, QWidget)

resize()

resizeEvent(self, QResizeEvent)

restoreGeometry(self, Union[QByteArray, ...)

restoreState(self, Union[QByteArray, bytes, ...)

saveGeometry(self)

saveState(self)

screen(self)

screenshot([path, flash])

Take currently displayed screen and convert to an image array.

scroll()

sender(self)

senderSignalIndex(self)

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

setAttribute(self, Qt.WidgetAttribute, on)

setAutoFillBackground(self, bool)

setBackgroundRole(self, QPalette.ColorRole)

setBaseSize()

setChildrenCollapsible(self, bool)

setCollapsible(self, int, bool)

setContentsMargins()

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

setCursor(self, Union[QCursor, Qt.CursorShape])

setDisabled(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize()

setFixedWidth(self, int)

setFocus()

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setFrameRect(self, QRect)

setFrameShadow(self, QFrame.Shadow)

setFrameShape(self, QFrame.Shape)

setFrameStyle(self, int)

setGeometry()

setGraphicsEffect(self, QGraphicsEffect)

setHandleWidth(self, int)

setHidden(self, bool)

setInputMethodHints(self, ...)

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLineWidth(self, int)

setLocale(self, QLocale)

setMask()

setMaximumHeight(self, int)

setMaximumSize()

setMaximumWidth(self, int)

setMidLineWidth(self, int)

setMinimumHeight(self, int)

setMinimumSize()

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjectName(self, str)

setOpaqueResize(self[, opaque])

setOrientation(self, Qt.Orientation)

setPalette(self, QPalette)

setParent()

setProperty(self, str, Any)

setRubberBand(self, int)

setShortcutAutoRepeat(self, int[, enabled])

setShortcutEnabled(self, int[, enabled])

setSizeIncrement()

setSizePolicy()

setSizes(self, Iterable[int])

setStatusTip(self, str)

setStretchFactor(self, int, int)

setStyle(self, QStyle)

setStyleSheet(self, str)

setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

setWindowFlag(self, Qt.WindowType, on)

setWindowFlags(self, Union[Qt.WindowFlags, ...)

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Union[Qt.WindowStates, ...)

setWindowTitle(self, str)

set_welcome_visible(visible)

Show welcome screen widget.

sharedPainter(self)

show(self)

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self)

size(self)

sizeHint(self)

sizeIncrement(self)

sizePolicy(self)

sizes(self)

stackUnder(self, QWidget)

startTimer(self, int[, timerType])

statusTip(self)

style(self)

styleSheet(self)

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute)

thread(self)

timerEvent(self, QTimerEvent)

toggle_console_visibility([event])

Toggle console visible and not visible.

toolTip(self)

toolTipDuration(self)

tr(self, str[, disambiguation, n])

underMouse(self)

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(-> None  -> None)

updateGeometry(self)

updateMicroFocus(self)

updatesEnabled(self)

visibleRegion(self)

whatsThis(self)

wheelEvent(self, QWheelEvent)

widget(self, int)

width(self)

widthMM(self)

winId(self)

window(self)

windowFilePath(self)

windowFlags(self)

windowHandle(self)

windowIcon(self)

windowIconText(self)

windowModality(self)

windowOpacity(self)

windowRole(self)

windowState(self)

windowTitle(self)

windowType(self)

x(self)

y(self)

Attributes

Box

DrawChildren

DrawWindowBackground

HLine

IgnoreMask

NoFrame

Panel

PdmDepth

PdmDevicePixelRatio

PdmDevicePixelRatioScaled

PdmDpiX

PdmDpiY

PdmHeight

PdmHeightMM

PdmNumColors

PdmPhysicalDpiX

PdmPhysicalDpiY

PdmWidth

PdmWidthMM

Plain

Raised

Shadow_Mask

Shape_Mask

StyledPanel

Sunken

VLine

WinPanel

console

iPython console terminal integrated into the napari GUI.

controls

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

destroyed

QObject = None) [signal]

dockConsole

dockLayerControls

dockLayerList

dockPerformance

layerButtons

layers

objectNameChanged

objectNameChanged(self, str) [signal]

splitterMoved

splitterMoved(self, int, int) [signal]

staticMetaObject

viewerButtons

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowTitleChanged

windowTitleChanged(self, str) [signal]

Details

class PaintDeviceMetric

Bases: int

class RenderFlag

Bases: int

class RenderFlags
class RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) None
class RenderFlags(QWidget.RenderFlags) None

Bases: sip.simplewrapper

class Shadow

Bases: int

class Shape

Bases: int

class StyleMask

Bases: int

acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, QActionEvent)
actions(self) List[QAction]
activateWindow(self)
addAction(self, QAction)
addActions(self, Iterable[QAction])
addWidget(self, QWidget)
adjustSize(self)
autoFillBackground(self) bool
backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, bool) bool
changeEvent(self, QEvent)
childAt(self, QPoint) QWidget
QtViewer.childAt(self, int, int) -> QWidget
childEvent(self, QChildEvent)
children(self) List[QObject]
childrenCollapsible(self) bool
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
clipboard(flash=True)[source]

Take a screenshot of the currently displayed screen and copy the image to the clipboard.

Parameters

flash (bool) – Flag to indicate whether flash animation should be shown after the screenshot was captured.

close(self) bool
closeEvent(event)[source]

Cleanup and close.

Parameters

event (qtpy.QtCore.QCloseEvent) – Event from the Qt context.

QtViewer.closestLegalPosition(self, int, int) -> int
colorCount(self) int
connectNotify(self, QMetaMethod)
property console

iPython console terminal integrated into the napari GUI.

Type

QtConsole

contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
count(self) int
create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createHandle(self) QSplitterHandle
createWindowContainer(QWindow, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) QWidget
cursor(self) QCursor
customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

QObject = None) [signal]

Type

destroyed(self, object

devType(self) int
devicePixelRatio(self) int
devicePixelRatioF(self) float
devicePixelRatioFScale() float
disconnect(QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, QMetaMethod)
dragEnterEvent(event)[source]

Ignore event if not dragging & dropping a file or URL to open.

Using event.ignore() here allows the event to pass through the parent widget to its child widget, otherwise the parent widget would catch the event and not pass it on to the child widget.

Parameters

event (qtpy.QtCore.QDragEvent) – Event from the Qt context.

dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
drawFrame(self, QPainter)
dropEvent(event)[source]

Add local files and web URLS with drag and drop.

For each file, attempt to open with existing associated reader (if available). If no reader is associated or opening fails, and more than one reader is available, open dialog and ask user to choose among available readers. User can choose to persist this choice.

Parameters

event (qtpy.QtCore.QDropEvent) – Event from the Qt context.

dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
effectiveWinId(self) PyQt5.sip.voidptr
ensurePolished(self)
enterEvent(self, QEvent)
event(self, QEvent) bool
eventFilter(self, QObject, QEvent) bool
find(PyQt5.sip.voidptr) QWidget
findChild(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) QObject
findChild(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) QObject
findChildren(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) List[QObject]
focusInEvent(self, QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, bool) bool
focusOutEvent(self, QFocusEvent)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget
focusWidget(self) QWidget
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameRect(self) QRect
frameShadow(self) QFrame.Shadow
frameShape(self) QFrame.Shape
frameSize(self) QSize
frameStyle(self) int
frameWidth(self) int
geometry(self) QRect
getContentsMargins(self) Tuple[int, int, int, int]
getRange(self, int) Tuple[int, int]
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) QPixmap
grabGesture(self, Qt.GestureType, flags: Union[Qt.GestureFlags, Qt.GestureFlag] = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, Union[QCursor, Qt.CursorShape]) None
grabShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect
graphicsProxyWidget(self) QGraphicsProxyWidget
handle(self, int) QSplitterHandle
handleWidth(self) int
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
height(self) int
heightForWidth(self, int) int
heightMM(self) int
hide(self)
hideEvent(self, QHideEvent)
indexOf(self, QWidget) int
inherits(self, str) bool
initPainter(self, QPainter)
initStyleOption(self, QStyleOptionFrame)
inputMethodEvent(self, QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHints
inputMethodQuery(self, Qt.InputMethodQuery) Any
QtViewer.insertAction(self, QAction, QAction)
insertActions(self, QAction, Iterable[QAction])
insertWidget(self, int, QWidget)
installEventFilter(self, QObject)
isActiveWindow(self) bool
isAncestorOf(self, QWidget) bool
isCollapsible(self, int) bool
isEnabled(self) bool
isEnabledTo(self, QWidget) bool
isFullScreen(self) bool
isHidden(self) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isRightToLeft(self) bool
isSignalConnected(self, QMetaMethod) bool
isVisible(self) bool
isVisibleTo(self, QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
keyPressEvent(event)[source]

Called whenever a key is pressed.

Parameters

event (qtpy.QtCore.QEvent) – Event from the Qt context.

keyReleaseEvent(event)[source]

Called whenever a key is released.

Parameters

event (qtpy.QtCore.QEvent) – Event from the Qt context.

keyboardGrabber() QWidget
killTimer(self, int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, QEvent)
lineWidth(self) int
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self)
mapFrom(self, QWidget, QPoint) QPoint
mapFromGlobal(self, QPoint) QPoint
mapFromParent(self, QPoint) QPoint
mapTo(self, QWidget, QPoint) QPoint
mapToGlobal(self, QPoint) QPoint
mapToParent(self, QPoint) QPoint
mask(self) QRegion
maximumHeight(self) int
maximumSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, QPaintDevice.PaintDeviceMetric) int
midLineWidth(self) int
minimumHeight(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
mouseDoubleClickEvent(self, QMouseEvent)
mouseGrabber() QWidget
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
move(self, QPoint)
QtViewer.move(self, int, int) -> None
moveEvent(self, QMoveEvent)
QtViewer.moveSplitter(self, int, int)
moveToThread(self, QThread)
nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) Tuple[bool, int]
nativeParentWidget(self) QWidget
nextInFocusChain(self) QWidget
normalGeometry(self) QRect
objectName(self) str
objectNameChanged

objectNameChanged(self, str) [signal]

on_draw(event)[source]

Called whenever the canvas is drawn.

This is triggered from vispy whenever new data is sent to the canvas or the camera is moved and is connected in the QtViewer.

on_mouse_double_click(event)[source]

Called whenever a mouse double-click happen on the canvas

Parameters

event (vispy.event.Event) – The vispy event that triggered this method. The event.type will always be mouse_double_click

Notes

Note that this triggers in addition to the usual mouse press and mouse release. Therefore a double click from the user will likely triggers the following event in sequence:

  • mouse_press

  • mouse_release

  • mouse_double_click

  • mouse_release

on_mouse_move(event)[source]

Called whenever mouse moves over canvas.

Parameters

event (vispy.event.Event) – The vispy event that triggered this method.

on_mouse_press(event)[source]

Called whenever mouse pressed in canvas.

Parameters

event (vispy.event.Event) – The vispy event that triggered this method.

on_mouse_release(event)[source]

Called whenever mouse released in canvas.

Parameters

event (vispy.event.Event) – The vispy event that triggered this method.

on_mouse_wheel(event)[source]

Called whenever mouse wheel activated in canvas.

Parameters

event (vispy.event.Event) – The vispy event that triggered this method.

on_resize(event)[source]

Called whenever canvas is resized.

eventvispy.util.event.Event

The vispy event that triggered this method.

opaqueResize(self) bool
orientation(self) Qt.Orientation
overrideWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])
overrideWindowState(self, Union[Qt.WindowStates, Qt.WindowState])
paintEngine(self) QPaintEngine
paintEvent(self, QPaintEvent)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject
parentWidget(self) QWidget
physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
previousInFocusChain(self) QWidget
property(self, str) Any
pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)
receivers(self, PYQT_SIGNAL) int
rect(self) QRect
refresh(self)
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, int)
removeAction(self, QAction)
removeEventFilter(self, QObject)
render(self, QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))
render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren)) None
repaint(self)
QtViewer.repaint(self, int, int, int, int) -> None
repaint(self, QRect) None
repaint(self, QRegion) None
replaceWidget(self, int, QWidget) QWidget
resize(self, QSize)
QtViewer.resize(self, int, int) -> None
resizeEvent(self, QResizeEvent)
restoreGeometry(self, Union[QByteArray, bytes, bytearray]) bool
restoreState(self, Union[QByteArray, bytes, bytearray]) bool
saveGeometry(self) QByteArray
saveState(self) QByteArray
screen(self) QScreen
screenshot(path=None, flash=True)[source]

Take currently displayed screen and convert to an image array.

Parameters
  • path (str) – Filename for saving screenshot image.

  • flash (bool) – Flag to indicate whether flash animation should be shown after the screenshot was captured.

Returns

image – Numpy array of type ubyte and shape (h, w, 4). Index [0, 0] is the upper-left corner of the rendered region.

Return type

array

QtViewer.scroll(self, int, int)
QtViewer.scroll(self, int, int, QRect) -> None
sender(self) QObject
senderSignalIndex(self) int
setAcceptDrops(self, bool)
setAccessibleDescription(self, str)
setAccessibleName(self, str)
setAttribute(self, Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, bool)
setBackgroundRole(self, QPalette.ColorRole)
QtViewer.setBaseSize(self, int, int)
setBaseSize(self, QSize) None
setChildrenCollapsible(self, bool)
setCollapsible(self, int, bool)
QtViewer.setContentsMargins(self, int, int, int, int)
setContentsMargins(self, QMargins) None
setContextMenuPolicy(self, Qt.ContextMenuPolicy)
setCursor(self, Union[QCursor, Qt.CursorShape])
setDisabled(self, bool)
setEnabled(self, bool)
setFixedHeight(self, int)
setFixedSize(self, QSize)
QtViewer.setFixedSize(self, int, int) -> None
setFixedWidth(self, int)
setFocus(self)
setFocus(self, Qt.FocusReason) None
setFocusPolicy(self, Qt.FocusPolicy)
setFocusProxy(self, QWidget)
setFont(self, QFont)
setForegroundRole(self, QPalette.ColorRole)
setFrameRect(self, QRect)
setFrameShadow(self, QFrame.Shadow)
setFrameShape(self, QFrame.Shape)
setFrameStyle(self, int)
setGeometry(self, QRect)
QtViewer.setGeometry(self, int, int, int, int) -> None
setGraphicsEffect(self, QGraphicsEffect)
setHandleWidth(self, int)
setHidden(self, bool)
setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])
setLayout(self, QLayout)
setLayoutDirection(self, Qt.LayoutDirection)
setLineWidth(self, int)
setLocale(self, QLocale)
setMask(self, QBitmap)
setMask(self, QRegion) None
setMaximumHeight(self, int)
QtViewer.setMaximumSize(self, int, int)
setMaximumSize(self, QSize) None
setMaximumWidth(self, int)
setMidLineWidth(self, int)
setMinimumHeight(self, int)
QtViewer.setMinimumSize(self, int, int)
setMinimumSize(self, QSize) None
setMinimumWidth(self, int)
setMouseTracking(self, bool)
setObjectName(self, str)
setOpaqueResize(self, opaque: bool = True)
setOrientation(self, Qt.Orientation)
setPalette(self, QPalette)
setParent(self, QWidget)
setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType]) None
setProperty(self, str, Any) bool
setRubberBand(self, int)
setShortcutAutoRepeat(self, int, enabled: bool = True)
setShortcutEnabled(self, int, enabled: bool = True)
QtViewer.setSizeIncrement(self, int, int)
setSizeIncrement(self, QSize) None
setSizePolicy(self, QSizePolicy)
setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy) None
setSizes(self, Iterable[int])
setStatusTip(self, str)
QtViewer.setStretchFactor(self, int, int)
setStyle(self, QStyle)
setStyleSheet(self, str)
QtViewer.setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setToolTip(self, str)
setToolTipDuration(self, int)
setUpdatesEnabled(self, bool)
setVisible(self, bool)
setWhatsThis(self, str)
setWindowFilePath(self, str)
setWindowFlag(self, Qt.WindowType, on: bool = True)
setWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])
setWindowIcon(self, QIcon)
setWindowIconText(self, str)
setWindowModality(self, Qt.WindowModality)
setWindowModified(self, bool)
setWindowOpacity(self, float)
setWindowRole(self, str)
setWindowState(self, Union[Qt.WindowStates, Qt.WindowState])
setWindowTitle(self, str)
set_welcome_visible(visible)[source]

Show welcome screen widget.

sharedPainter(self) QPainter
show(self)
showEvent(self, QShowEvent)
showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
signalsBlocked(self) bool
size(self) QSize
sizeHint(self) QSize
sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
sizes(self) List[int]
splitterMoved

splitterMoved(self, int, int) [signal]

stackUnder(self, QWidget)
startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) int
statusTip(self) str
style(self) QStyle
styleSheet(self) str
tabletEvent(self, QTabletEvent)
testAttribute(self, Qt.WidgetAttribute) bool
thread(self) QThread
timerEvent(self, QTimerEvent)
toggle_console_visibility(event=None)[source]

Toggle console visible and not visible.

Imports the console the first time it is requested.

toolTip(self) str
toolTipDuration(self) int
tr(self, str, disambiguation: str = None, n: int = - 1) str
underMouse(self) bool
ungrabGesture(self, Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, QRect) None
update(self, QRegion) None
QtViewer.update(self, int, int, int, int) -> None
updateGeometry(self)
updateMicroFocus(self)
updatesEnabled(self) bool
visibleRegion(self) QRegion
whatsThis(self) str
wheelEvent(self, QWheelEvent)
widget(self, int) QWidget
width(self) int
widthMM(self) int
winId(self) PyQt5.sip.voidptr
window(self) QWidget
windowFilePath(self) str
windowFlags(self) Qt.WindowFlags
windowHandle(self) QWindow
windowIcon(self) QIcon
windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) str
windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowStates
windowTitle(self) str
windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) Qt.WindowType
x(self) int
y(self) int