napari.qt.QtViewer#

class napari.qt.QtViewer(viewer: ViewerModel, show_welcome_screen: bool = False, canvas_class: type[VispyCanvas] = <class 'napari._vispy.canvas.VispyCanvas'>)[source]#

Bases: 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_class (napari._vispy.canvas.VispyCanvas) – The VispyCanvas class providing the Vispy SceneCanvas. Users can also have a custom canvas here.

canvas#

The VispyCanvas class providing the Vispy SceneCanvas. Users can also have a custom canvas here.

Type:

napari._vispy.canvas.VispyCanvas

dims#

Dimension sliders; Qt View for Dims model.

Type:

napari.qt_dims.QtDims

show_welcome_screen#

Boolean indicating whether to show the welcome screen.

Type:

bool

viewer#

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

Type:

napari.components.ViewerModel

_key_map_handler#

KeymapHandler handling the calling functionality when keys are pressed that have a callback function mapped

Type:

napari.utils.key_bindings.KeymapHandler

_qt_poll#

A QtPoll object required for the monitor.

Type:

Optional[napari._qt.experimental.qt_poll.QtPoll]

_remote_manager#

A remote manager processing commands from remote clients and sending out messages when polled.

Type:

napari.components.experimental.remote.RemoteManager

_welcome_widget#

QtWidgetOverlay providing the stacked widgets for the welcome page.

Type:

napari._qt.widgets.qt_welcome.QtWidgetOverlay

Inherited-members:

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(-> Optional[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(-> QObjectT)

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)

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

camera

The Vispy camera class which contains both the 2d and 3d camera used to describe the perspective by which a scene is viewed and interacted with.

chunk_receiver

console

iPython console terminal integrated into the napari GUI.

console_backlog

items to push to console when instantiated.

controls

Qt view for GUI controls.

customContextMenuRequested

int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

destroyed

int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

dockConsole

QWidget wrapped in a QDockWidget with forwarded viewer events.

dockLayerControls

QWidget wrapped in a QDockWidget with forwarded viewer events.

dockLayerList

QWidget wrapped in a QDockWidget with forwarded viewer events.

dockPerformance

layerButtons

Button controls for napari layers.

layer_to_visual

Mapping of Napari layer to Vispy layer.

layers

Qt view for LayerList controls.

objectNameChanged

int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

splitterMoved

int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

staticMetaObject

view

Rectangular vispy viewbox widget in which a subscene is rendered.

viewerButtons

Button controls for the napari viewer.

windowIconChanged

int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

windowIconTextChanged

int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

windowTitleChanged

int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

Details

add_to_console_backlog(variables)[source]#

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.

property camera#

The Vispy camera class which contains both the 2d and 3d camera used to describe the perspective by which a scene is viewed and interacted with. Access directly within the QtViewer will become deprecated.

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.

closeEvent(event)[source]#

Cleanup and close.

Parameters:

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

property console#

iPython console terminal integrated into the napari GUI.

Type:

QtConsole

property console_backlog#

items to push to console when instantiated.

Type:

List

property controls: QtLayerControlsContainer#

Qt view for GUI controls.

property dockConsole: QtViewerDockWidget#

QWidget wrapped in a QDockWidget with forwarded viewer events.

property dockLayerControls: QtViewerDockWidget#

QWidget wrapped in a QDockWidget with forwarded viewer events.

property dockLayerList: QtViewerDockWidget#

QWidget wrapped in a QDockWidget with forwarded viewer events.

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.

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.

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.

property layerButtons: QtLayerButtons#

Button controls for napari layers.

property layer_to_visual#

Mapping of Napari layer to Vispy layer. Added for backward compatibility

property layers: QtLayerList#

Qt view for LayerList controls.

screenshot(path=None, flash=True) ndarray[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

set_welcome_visible(visible)[source]#

Show welcome screen widget.

toggle_console_visibility(event=None)[source]#

Toggle console visible and not visible.

Imports the console the first time it is requested.

property view#

Rectangular vispy viewbox widget in which a subscene is rendered. Access directly within the QtViewer will become deprecated.

property viewerButtons: QtViewerButtons#

Button controls for the napari viewer.