napari.qt.QtViewer

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

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, a0)
actions(self)
activateWindow(self)
addAction(self, action)
addActions(self, actions)
addWidget(self, widget)
add_to_console_backlog(variables)	Save variables for pushing to console when it is instantiated.
adjustSize(self)
autoFillBackground(self)
backgroundRole(self)
baseSize(self)
blockSignals(self, b)
changeEvent(self, a0)
childAt(-> QWidget)
childEvent(self, a0)
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, a0, a1)
colorCount(self)
connectNotify(self, signal)
contentsMargins(self)
contentsRect(self)
contextMenuEvent(self, a0)
contextMenuPolicy(self)
count(self)
create(self[, window, initializeWindow, ...])
createHandle(self)
createWindowContainer(window[, parent, flags])
cursor(self)
customEvent(self, a0)
deleteLater(self)
depth(self)
destroy(self[, destroyWindow, destroySubWindows])
devType(self)
devicePixelRatio(self)
devicePixelRatioF(self)
devicePixelRatioFScale()
disconnect(-> bool)
disconnectNotify(self, signal)
dragEnterEvent(event)	Ignore event if not dragging & dropping a file or URL to open.
dragLeaveEvent(self, a0)
dragMoveEvent(self, a0)
drawFrame(self, a0)
dropEvent(event)	Add local files and web URLS with drag and drop.
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self)
effectiveWinId(self)
ensurePolished(self)
enterEvent(self, a0)
event(self, a0)
eventFilter(self, a0, a1)
find(a0)
findChild(-> QObject)
findChildren(...)
focusInEvent(self, a0)
focusNextChild(self)
focusNextPrevChild(self, next)
focusOutEvent(self, a0)
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, index)
grab(self[, rectangle])
grabGesture(self, type[, flags])
grabKeyboard(self)
grabMouse()
grabShortcut(self, key[, context])
graphicsEffect(self)
graphicsProxyWidget(self)
handle(self, index)
handleWidth(self)
hasFocus(self)
hasHeightForWidth(self)
hasMouseTracking(self)
hasTabletTracking(self)
height(self)
heightForWidth(self, a0)
heightMM(self)
hide(self)
hideEvent(self, a0)
indexOf(self, w)
inherits(self, classname)
initPainter(self, painter)
initStyleOption(self, option)
inputMethodEvent(self, a0)
inputMethodHints(self)
inputMethodQuery(self, a0)
insertAction(self, before, action)
insertActions(self, before, actions)
insertWidget(self, index, widget)
installEventFilter(self, a0)
isActiveWindow(self)
isAncestorOf(self, child)
isCollapsible(self, index)
isEnabled(self)
isEnabledTo(self, a0)
isFullScreen(self)
isHidden(self)
isLeftToRight(self)
isMaximized(self)
isMinimized(self)
isModal(self)
isRightToLeft(self)
isSignalConnected(self, signal)
isVisible(self)
isVisibleTo(self, a0)
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, id)
layout(self)
layoutDirection(self)
leaveEvent(self, a0)
lineWidth(self)
locale(self)
logicalDpiX(self)
logicalDpiY(self)
lower(self)
mapFrom(self, a0, a1)
mapFromGlobal(self, a0)
mapFromParent(self, a0)
mapTo(self, a0, a1)
mapToGlobal(self, a0)
mapToParent(self, a0)
mask(self)
maximumHeight(self)
maximumSize(self)
maximumWidth(self)
metaObject(self)
metric(self, a0)
midLineWidth(self)
minimumHeight(self)
minimumSize(self)
minimumSizeHint(self)
minimumWidth(self)
mouseDoubleClickEvent(self, a0)
mouseGrabber()
mouseMoveEvent(self, a0)
mousePressEvent(self, a0)
mouseReleaseEvent(self, a0)
move()
moveEvent(self, a0)
moveSplitter(self, pos, index)
moveToThread(self, thread)
nativeEvent(self, eventType, message)
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, type)
overrideWindowState(self, state)
paintEngine(self)
paintEvent(self, a0)
paintingActive(self)
palette(self)
parent(self)
parentWidget(self)
physicalDpiX(self)
physicalDpiY(self)
pos(self)
previousInFocusChain(self)
property(self, name)
pyqtConfigure(...)	Each keyword argument is either the name of a Qt property or a Qt signal.
raise_(self)
receivers(self, signal)
rect(self)
refresh(self)
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id)
removeAction(self, action)
removeEventFilter(self, a0)
render(, sourceRegion, flags, ...)
repaint(-> None  -> None)
replaceWidget(self, index, widget)
resize()
resizeEvent(self, a0)
restoreGeometry(self, geometry)
restoreState(self, state)
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, on)
setAccessibleDescription(self, description)
setAccessibleName(self, name)
setAttribute(self, attribute[, on])
setAutoFillBackground(self, enabled)
setBackgroundRole(self, a0)
setBaseSize()
setChildrenCollapsible(self, a0)
setCollapsible(self, index, a1)
setContentsMargins()
setContextMenuPolicy(self, policy)
setCursor(self, a0)
setDisabled(self, a0)
setEnabled(self, a0)
setFixedHeight(self, h)
setFixedSize()
setFixedWidth(self, w)
setFocus()
setFocusPolicy(self, policy)
setFocusProxy(self, a0)
setFont(self, a0)
setForegroundRole(self, a0)
setFrameRect(self, a0)
setFrameShadow(self, a0)
setFrameShape(self, a0)
setFrameStyle(self, a0)
setGeometry()
setGraphicsEffect(self, effect)
setHandleWidth(self, a0)
setHidden(self, hidden)
setInputMethodHints(self, hints)
setLayout(self, a0)
setLayoutDirection(self, direction)
setLineWidth(self, a0)
setLocale(self, locale)
setMask()
setMaximumHeight(self, maxh)
setMaximumSize()
setMaximumWidth(self, maxw)
setMidLineWidth(self, a0)
setMinimumHeight(self, minh)
setMinimumSize()
setMinimumWidth(self, minw)
setMouseTracking(self, enable)
setObjectName(self, name)
setOpaqueResize(self[, opaque])
setOrientation(self, a0)
setPalette(self, a0)
setParent()
setProperty(self, name, value)
setRubberBand(self, position)
setShortcutAutoRepeat(self, id[, enabled])
setShortcutEnabled(self, id[, enabled])
setSizeIncrement()
setSizePolicy()
setSizes(self, list)
setStatusTip(self, a0)
setStretchFactor(self, index, stretch)
setStyle(self, a0)
setStyleSheet(self, styleSheet)
setTabOrder(a0, a1)
setTabletTracking(self, enable)
setToolTip(self, a0)
setToolTipDuration(self, msec)
setUpdatesEnabled(self, enable)
setVisible(self, visible)
setWhatsThis(self, a0)
setWindowFilePath(self, filePath)
setWindowFlag(self, a0[, on])
setWindowFlags(self, type)
setWindowIcon(self, icon)
setWindowIconText(self, a0)
setWindowModality(self, windowModality)
setWindowModified(self, a0)
setWindowOpacity(self, level)
setWindowRole(self, a0)
setWindowState(self, state)
setWindowTitle(self, a0)
set_welcome_visible(visible)	Show welcome screen widget.
sharedPainter(self)
show(self)
showEvent(self, a0)
showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
signalsBlocked(self)
size(self)
sizeHint(self)
sizeIncrement(self)
sizePolicy(self)
sizes(self)
stackUnder(self, a0)
startTimer(self, interval[, timerType])
statusTip(self)
style(self)
styleSheet(self)
tabletEvent(self, a0)
testAttribute(self, attribute)
thread(self)
timerEvent(self, a0)
toggle_console_visibility([event])	Toggle console visible and not visible.
toolTip(self)
toolTipDuration(self)
tr(self, sourceText[, disambiguation, n])
underMouse(self)
ungrabGesture(self, type)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(-> None  -> None)
updateGeometry(self)
updateMicroFocus(self)
updatesEnabled(self)
visibleRegion(self)
whatsThis(self)
wheelEvent(self, a0)
widget(self, index)
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.
console_backlog	items to push to console when instantiated.
controls
customContextMenuRequested	QPoint) [signal]
destroyed	typing.Optional[QObject] = None) [signal]
dockConsole
dockLayerControls
dockLayerList
dockPerformance
layerButtons
layers
objectNameChanged	str) [signal]
splitterMoved	int) [signal]
staticMetaObject
viewerButtons
windowIconChanged	QIcon) [signal]
windowIconTextChanged	str) [signal]
windowTitleChanged	str) [signal]

Details

class PaintDeviceMetric

Bases: int

class RenderFlag

Bases: int

class RenderFlags

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

class RenderFlags(a0: 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, a0: QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, action: QAction)

addActions(self, actions: Iterable[QAction])

addWidget(self, widget: QWidget)

add_to_console_backlog(variables)

Save variables for pushing to console when it is instantiated.

This function will create weakrefs when possible to avoid holding on to too much memory unnecessarily.

Parameters

variables (dict, str or list/tuple of str) – The variables to inject into the console’s namespace. If a dict, a simple update is done. If a str, the string is assumed to have variable names separated by spaces. A list/tuple of str can also be used to give the variable names. If just the variable names are give (list/tuple/str) then the variable values looked up in the callers frame.

adjustSize(self)

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, b: bool) → bool

changeEvent(self, a0: QEvent)

childAt(self, p: QPoint) → QWidget

childAt(self, ax: int, ay: int) → QWidget

childEvent(self, a0: QChildEvent)

children(self) → List[QObject]

childrenCollapsible(self) → bool

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

clipboard(flash=True)

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)

Cleanup and close.

Parameters

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

closestLegalPosition(self, a0: int, a1: int) → int

colorCount(self) → int

connectNotify(self, signal: QMetaMethod)

property console

iPython console terminal integrated into the napari GUI.

Type

QtConsole

property console_backlog

items to push to console when instantiated.

Type

List

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, a0: 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(window: QWindow, parent: Optional[QWidget] = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) → QWidget

cursor(self) → QCursor

customContextMenuRequested

QPoint) [signal]

Type

customContextMenuRequested(self, pos

customEvent(self, a0: QEvent)

deleteLater(self)

depth(self) → int

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

destroyed

typing.Optional[QObject] = None) [signal]

Type

destroyed(self, object

devType(self) → int

devicePixelRatio(self) → int

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(a0: QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, signal: QMetaMethod)

dragEnterEvent(event)

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, a0: QDragLeaveEvent)

dragMoveEvent(self, a0: QDragMoveEvent)

drawFrame(self, a0: QPainter)

dropEvent(event)

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, a0: QEvent)

event(self, a0: QEvent) → bool

eventFilter(self, a0: QObject, a1: QEvent) → bool

find(a0: PyQt5.sip.voidptr) → QWidget

findChild(self, type: type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject

findChild(self, types: Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject

findChildren(self, type: type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, types: Tuple, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, type: type, regExp: QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, types: Tuple, regExp: QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, type: type, re: QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, types: Tuple, re: QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

focusInEvent(self, a0: QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, next: bool) → bool

focusOutEvent(self, a0: 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, index: int) → Tuple[int, int]

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) → QPixmap

grabGesture(self, type: Qt.GestureType, flags: Union[Qt.GestureFlags, Qt.GestureFlag] = Qt.GestureFlags())

grabKeyboard(self)

grabMouse(self)

grabMouse(self, a0: Union[QCursor, Qt.CursorShape]) → None

grabShortcut(self, key: Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) → int

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

handle(self, index: int) → QSplitterHandle

handleWidth(self) → int

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, a0: int) → int

heightMM(self) → int

hide(self)

hideEvent(self, a0: QHideEvent)

indexOf(self, w: QWidget) → int

inherits(self, classname: str) → bool

initPainter(self, painter: QPainter)

initStyleOption(self, option: QStyleOptionFrame)

inputMethodEvent(self, a0: QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHints

inputMethodQuery(self, a0: Qt.InputMethodQuery) → Any

insertAction(self, before: QAction, action: QAction)

insertActions(self, before: QAction, actions: Iterable[QAction])

insertWidget(self, index: int, widget: QWidget)

installEventFilter(self, a0: QObject)

isActiveWindow(self) → bool

isAncestorOf(self, child: QWidget) → bool

isCollapsible(self, index: int) → bool

isEnabled(self) → bool

isEnabledTo(self, a0: 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, signal: QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, a0: QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(event)

Called whenever a key is pressed.

Parameters

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

keyReleaseEvent(event)

Called whenever a key is released.

Parameters

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

keyboardGrabber() → QWidget

killTimer(self, id: int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, a0: QEvent)

lineWidth(self) → int

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, a0: QWidget, a1: QPoint) → QPoint

mapFromGlobal(self, a0: QPoint) → QPoint

mapFromParent(self, a0: QPoint) → QPoint

mapTo(self, a0: QWidget, a1: QPoint) → QPoint

mapToGlobal(self, a0: QPoint) → QPoint

mapToParent(self, a0: QPoint) → QPoint

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, a0: QPaintDevice.PaintDeviceMetric) → int

midLineWidth(self) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, a0: QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, a0: QMouseEvent)

mousePressEvent(self, a0: QMouseEvent)

mouseReleaseEvent(self, a0: QMouseEvent)

move(self, a0: QPoint)

move(self, ax: int, ay: int) → None

moveEvent(self, a0: QMoveEvent)

moveSplitter(self, pos: int, index: int)

moveToThread(self, thread: QThread)

nativeEvent(self, eventType: Union[QByteArray, bytes, bytearray], message: PyQt5.sip.voidptr) → Tuple[bool, int]

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

str) [signal]

Type

objectNameChanged(self, objectName

on_draw(event)

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)

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)

Called whenever mouse moves over canvas.

Parameters

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

on_mouse_press(event)

Called whenever mouse pressed in canvas.

Parameters

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

on_mouse_release(event)

Called whenever mouse released in canvas.

Parameters

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

on_mouse_wheel(event)

Called whenever mouse wheel activated in canvas.

Parameters

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

on_resize(event)

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, type: Union[Qt.WindowFlags, Qt.WindowType])

overrideWindowState(self, state: Union[Qt.WindowStates, Qt.WindowState])

paintEngine(self) → QPaintEngine

paintEvent(self, a0: 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, name: 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, signal: PYQT_SIGNAL) → int

rect(self) → QRect

refresh(self)

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, id: int)

removeAction(self, action: QAction)

removeEventFilter(self, a0: QObject)

render(self, target: QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))

render(self, painter: QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren)) → None

repaint(self)

repaint(self, x: int, y: int, w: int, h: int) → None

repaint(self, a0: QRect) → None

repaint(self, a0: QRegion) → None

replaceWidget(self, index: int, widget: QWidget) → QWidget

resize(self, a0: QSize)

resize(self, w: int, h: int) → None

resizeEvent(self, a0: QResizeEvent)

restoreGeometry(self, geometry: Union[QByteArray, bytes, bytearray]) → bool

restoreState(self, state: Union[QByteArray, bytes, bytearray]) → bool

saveGeometry(self) → QByteArray

saveState(self) → QByteArray

screen(self) → QScreen

screenshot(path=None, flash=True)

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

scroll(self, dx: int, dy: int)

scroll(self, dx: int, dy: int, a2: QRect) → None

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, on: bool)

setAccessibleDescription(self, description: str)

setAccessibleName(self, name: str)

setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)

setAutoFillBackground(self, enabled: bool)

setBackgroundRole(self, a0: QPalette.ColorRole)

setBaseSize(self, basew: int, baseh: int)

setBaseSize(self, s: QSize) → None

setChildrenCollapsible(self, a0: bool)

setCollapsible(self, index: int, a1: bool)

setContentsMargins(self, left: int, top: int, right: int, bottom: int)

setContentsMargins(self, margins: QMargins) → None

setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)

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

setDisabled(self, a0: bool)

setEnabled(self, a0: bool)

setFixedHeight(self, h: int)

setFixedSize(self, a0: QSize)

setFixedSize(self, w: int, h: int) → None

setFixedWidth(self, w: int)

setFocus(self)

setFocus(self, reason: Qt.FocusReason) → None

setFocusPolicy(self, policy: Qt.FocusPolicy)

setFocusProxy(self, a0: QWidget)

setFont(self, a0: QFont)

setForegroundRole(self, a0: QPalette.ColorRole)

setFrameRect(self, a0: QRect)

setFrameShadow(self, a0: QFrame.Shadow)

setFrameShape(self, a0: QFrame.Shape)

setFrameStyle(self, a0: int)

setGeometry(self, a0: QRect)

setGeometry(self, ax: int, ay: int, aw: int, ah: int) → None

setGraphicsEffect(self, effect: QGraphicsEffect)

setHandleWidth(self, a0: int)

setHidden(self, hidden: bool)

setInputMethodHints(self, hints: Union[Qt.InputMethodHints, Qt.InputMethodHint])

setLayout(self, a0: QLayout)

setLayoutDirection(self, direction: Qt.LayoutDirection)

setLineWidth(self, a0: int)

setLocale(self, locale: QLocale)

setMask(self, a0: QBitmap)

setMask(self, a0: QRegion) → None

setMaximumHeight(self, maxh: int)

setMaximumSize(self, maxw: int, maxh: int)

setMaximumSize(self, s: QSize) → None

setMaximumWidth(self, maxw: int)

setMidLineWidth(self, a0: int)

setMinimumHeight(self, minh: int)

setMinimumSize(self, minw: int, minh: int)

setMinimumSize(self, s: QSize) → None

setMinimumWidth(self, minw: int)

setMouseTracking(self, enable: bool)

setObjectName(self, name: str)

setOpaqueResize(self, opaque: bool = True)

setOrientation(self, a0: Qt.Orientation)

setPalette(self, a0: QPalette)

setParent(self, parent: QWidget)

setParent(self, parent: QWidget, f: Union[Qt.WindowFlags, Qt.WindowType]) → None

setProperty(self, name: str, value: Any) → bool

setRubberBand(self, position: int)

setShortcutAutoRepeat(self, id: int, enabled: bool = True)

setShortcutEnabled(self, id: int, enabled: bool = True)

setSizeIncrement(self, w: int, h: int)

setSizeIncrement(self, s: QSize) → None

setSizePolicy(self, a0: QSizePolicy)

setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) → None

setSizes(self, list: Iterable[int])

setStatusTip(self, a0: str)

setStretchFactor(self, index: int, stretch: int)

setStyle(self, a0: QStyle)

setStyleSheet(self, styleSheet: str)

setTabOrder(a0: QWidget, a1: QWidget)

setTabletTracking(self, enable: bool)

setToolTip(self, a0: str)

setToolTipDuration(self, msec: int)

setUpdatesEnabled(self, enable: bool)

setVisible(self, visible: bool)

setWhatsThis(self, a0: str)

setWindowFilePath(self, filePath: str)

setWindowFlag(self, a0: Qt.WindowType, on: bool = True)

setWindowFlags(self, type: Union[Qt.WindowFlags, Qt.WindowType])

setWindowIcon(self, icon: QIcon)

setWindowIconText(self, a0: str)

setWindowModality(self, windowModality: Qt.WindowModality)

setWindowModified(self, a0: bool)

setWindowOpacity(self, level: float)

setWindowRole(self, a0: str)

setWindowState(self, state: Union[Qt.WindowStates, Qt.WindowState])

setWindowTitle(self, a0: str)

set_welcome_visible(visible)

Show welcome screen widget.

sharedPainter(self) → QPainter

show(self)

showEvent(self, a0: 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

int) [signal]

Type

splitterMoved(self, pos

Type

int, index

stackUnder(self, a0: QWidget)

startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, a0: QTabletEvent)

testAttribute(self, attribute: Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, a0: QTimerEvent)

toggle_console_visibility(event=None)

Toggle console visible and not visible.

Imports the console the first time it is requested.

toolTip(self) → str

toolTipDuration(self) → int

tr(self, sourceText: str, disambiguation: Optional[str] = None, n: int = - 1) → str

underMouse(self) → bool

ungrabGesture(self, type: Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, a0: QRect) → None

update(self, a0: QRegion) → None

update(self, ax: int, ay: int, aw: int, ah: int) → None

updateGeometry(self)

updateMicroFocus(self)

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, a0: QWheelEvent)

widget(self, index: 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

QIcon) [signal]

Type

windowIconChanged(self, icon

windowIconText(self) → str

windowIconTextChanged

str) [signal]

Type

windowIconTextChanged(self, iconText

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowStates

windowTitle(self) → str

windowTitleChanged

str) [signal]

Type

windowTitleChanged(self, title

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

previous

napari.qt.QtToolTipLabel

next

napari.qt.QtViewerButtons