napari.qt.QtViewer

class napari.qt.QtViewer(viewer: ViewerModel, show_welcome_screen: bool = False, canvas_class: type[VispyCanvas] = <class 'napari._vispy.canvas.VispyCanvas'>, tips: Sequence[str] | None = None)

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.

• tips (Sequence[str] | None, optional) – Custom welcome-screen tips. By default, the built-in napari tips are used.

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

Methods

acceptDrops(self)
accessibleDescription(self)
accessibleIdentifier(self)
accessibleName(self)
actionEvent(self, a0)
actions(self)
activateWindow(self)
addAction(...)
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(...)
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, event)
event(self, a0)
eventFilter(self, a0, a1)
export_figure([path, scale, flash])	Export an image of the full extent of the displayed layer data.
export_rois(rois[, paths, scale])	Export the given rectangular rois to specified file paths.
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)
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)
isQuickItemType(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(-> QPoint)
mapFromGlobal(-> QPoint)
mapFromParent(-> QPoint)
mapTo(-> QPoint)
mapToGlobal(-> QPoint)
mapToParent(-> QPoint)
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, sourceRegion, ...)
repaint()
replaceWidget(self, index, widget)
resize()
resizeEvent(self, a0)
resize_canvas(size, scale)	Temporarily, safely, resize the canvas
restoreGeometry(self, geometry)
restoreState(self, state)
saveGeometry(self)
saveState(self)
screen(self)
screenshot([path, flash, size, scale, ...])	Take currently displayed screen and convert to an image array.
scroll()
sender(self)
senderSignalIndex(self)
setAcceptDrops(self, on)
setAccessibleDescription(self, description)
setAccessibleIdentifier(self, identifier)
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)
setScreen(self, a0)
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_tips(tips)	Replace the welcome screen tip pool.
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(sourceText[, disambiguation, n])
underMouse(self)
ungrabGesture(self, type)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update()
updateGeometry(self)
updateMicroFocus(self[, query])
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
PdmDevicePixelRatioF_EncodedA
PdmDevicePixelRatioF_EncodedB
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	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
show_welcome_screen	Whether to show the welcome screen when there are no layers.
splitterMoved	int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
staticMetaObject
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

class PaintDeviceMetric(*values)

Bases: Enum

class RenderFlag(*values)

Bases: Flag

class Shadow(*values)

Bases: IntEnum

as_integer_ratio()

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

classmethod from_bytes(bytes, byteorder='big', *, signed=False)

Return the integer represented by the given array of bytes.

imag

the imaginary part of a complex number

is_integer()

Returns True. Exists for duck type compatibility with float.is_integer.

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length=1, byteorder='big', *, signed=False)

Return an array of bytes representing an integer.

class Shape(*values)

Bases: IntEnum

as_integer_ratio()

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()

Returns self, the complex conjugate of any int.

denominator

the denominator of a rational number in lowest terms

classmethod from_bytes(bytes, byteorder='big', *, signed=False)

Return the integer represented by the given array of bytes.

imag

the imaginary part of a complex number

is_integer()

Returns True. Exists for duck type compatibility with float.is_integer.

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

to_bytes(length=1, byteorder='big', *, signed=False)

Return an array of bytes representing an integer.

class StyleMask(*values)

Bases: Enum

classmethod acceptDrops(self) → bool

classmethod accessibleDescription(self) → str

classmethod accessibleIdentifier(self) → str

classmethod accessibleName(self) → str

classmethod actionEvent(self, a0: QActionEvent | None)

classmethod actions(self) → list[QAction]

classmethod activateWindow(self)

classmethod addAction(self, icon: QIcon, text: str | None) → QAction | None

classmethod addAction(self, icon: QIcon, text: str | None, slot: PYQT_SLOT, type: Qt.ConnectionType = Qt.AutoConnection) → QAction | None

classmethod addAction(self, icon: QIcon, text: str | None, shortcut: QKeySequence | QKeySequence.StandardKey | str | None | int) → QAction | None

classmethod addAction(self, icon: QIcon, text: str | None, shortcut: QKeySequence | QKeySequence.StandardKey | str | None | int, slot: PYQT_SLOT, type: Qt.ConnectionType = Qt.AutoConnection) → QAction | None

classmethod addAction(self, text: str | None) → QAction | None

classmethod addAction(self, text: str | None, shortcut: QKeySequence | QKeySequence.StandardKey | str | None | int) → QAction | None

classmethod addAction(self, text: str | None, slot: PYQT_SLOT, type: Qt.ConnectionType = Qt.AutoConnection) → QAction | None

classmethod addAction(self, text: str | None, shortcut: QKeySequence | QKeySequence.StandardKey | str | None | int, slot: PYQT_SLOT, type: Qt.ConnectionType = Qt.AutoConnection) → QAction | None

classmethod addAction(self, action: QAction | None)

classmethod addActions(self, actions: Iterable[QAction])

classmethod addWidget(self, widget: QWidget | None)

add_to_console_backlog(variables: dict | str | list | tuple) → None

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.

classmethod adjustSize(self)

classmethod autoFillBackground(self) → bool

classmethod backgroundRole(self) → QPalette.ColorRole

classmethod baseSize(self) → QSize

classmethod blockSignals(self, b: bool) → bool

classmethod changeEvent(self, a0: QEvent | None)

classmethod childAt(self, p: QPoint) → QWidget | None

classmethod childAt(self, p: QPointF) → QWidget | None

classmethod childAt(self, ax: int, ay: int) → QWidget | None

classmethod childEvent(self, a0: QChildEvent | None)

classmethod children(self) → list[QObject]

classmethod childrenCollapsible(self) → bool

classmethod childrenRect(self) → QRect

classmethod childrenRegion(self) → QRegion

classmethod clearFocus(self)

classmethod clearMask(self)

clipboard(flash: bool = True) → None

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.

classmethod close(self) → bool

closeEvent(event: QCloseEvent | None) → None

Cleanup and close.

Parameters:

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

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

classmethod colorCount(self) → int

classmethod connectNotify(self, signal: QMetaMethod)

property console: QtConsole | None

iPython console terminal integrated into the napari GUI.

Type:

QtConsole

property console_backlog: list[dict[str, Any]]

items to push to console when instantiated.

Type:

List

classmethod contentsMargins(self) → QMargins

classmethod contentsRect(self) → QRect

classmethod contextMenuEvent(self, a0: QContextMenuEvent | None)

classmethod contextMenuPolicy(self) → Qt.ContextMenuPolicy

property controls: QtLayerControlsContainer

Qt view for GUI controls.

classmethod count(self) → int

classmethod create(self, window: PyQt6.sip.voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)

classmethod createHandle(self) → QSplitterHandle | None

classmethod createWindowContainer(window: QWindow | None, parent: QWidget | None = None, flags: Qt.WindowType = Qt.WindowFlags()) → QWidget

classmethod cursor(self) → QCursor

classmethod customEvent(self, a0: QEvent | None)

classmethod deleteLater(self)

classmethod depth(self) → int

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

classmethod devType(self) → int

classmethod devicePixelRatio(self) → float

classmethod devicePixelRatioF(self) → float

classmethod devicePixelRatioFScale() → float

classmethod disconnect(a0: QMetaObject.Connection) → bool

classmethod disconnect(self)

classmethod disconnectNotify(self, signal: QMetaMethod)

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: QDragEnterEvent | None) → None

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.

classmethod dragLeaveEvent(self, a0: QDragLeaveEvent | None)

classmethod dragMoveEvent(self, a0: QDragMoveEvent | None)

classmethod drawFrame(self, a0: QPainter | None)

dropEvent(event: QDropEvent | None) → None

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.

classmethod dumpObjectInfo(self)

classmethod dumpObjectTree(self)

classmethod dynamicPropertyNames(self) → list[QByteArray]

classmethod effectiveWinId(self) → PyQt6.sip.voidptr

classmethod ensurePolished(self)

classmethod enterEvent(self, event: QEnterEvent | None)

classmethod event(self, a0: QEvent | None) → bool

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

export_figure(path: str | None = None, scale: float = 1, flash: bool = True) → ndarray

Export an image of the full extent of the displayed layer data.

This function finds a tight boundary around the data, resets the view around that boundary (and, when scale=1, such that 1 captured pixel is equivalent to one data pixel), takes a screenshot, then restores the previous zoom and canvas sizes.

Parameters:

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

• scale (float) – Scale factor used to increase resolution of canvas for the screenshot. By default, a scale of 1.

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

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

export_rois(rois: list[ndarray], paths: str | Path | list[str | Path] | None = None, scale: float = 1.0) → list[ndarray]

Export the given rectangular rois to specified file paths.

For each shape, moves the camera to the center of the shape and adjust the canvas size to fit the shape. Note: The shape height and width can be of type float. However, the canvas size only accepts a tuple of integers. This can result in slight misalignment.

Parameters:

• rois (list[np.ndarray]) – A list of arrays with each being of shape (4, 2) representing a rectangular roi.

• paths (str, Path, list[str, Path], optional) – Where to save the rois. If a string or a Path, a directory will be created if it does not exist yet and screenshots will be saved with filename roi_{n}.png where n is the nth roi. If paths is a list of either string or paths, these need to be the full paths of where to store each individual roi. In this case the length of the list and the number of rois must match. If None, the screenshots will only be returned and not saved to disk.

• scale (float, optional) – Scale factor used to increase resolution of canvas for the screenshot. By default, uses the displayed scale.

Returns:

screenshot_list – The list with roi screenshots.

Return type:

list

classmethod find(a0: PyQt6.sip.voidptr) → QWidget | None

classmethod findChild(self, type: type[QObjectT], name: str | None = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObjectT

classmethod findChild(self, types: tuple[type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObjectT

classmethod findChildren(self, type: type[QObjectT], name: str | None = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]

classmethod findChildren(self, types: tuple[type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]

classmethod findChildren(self, type: type[QObjectT], re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]

classmethod findChildren(self, types: tuple[type[QObjectT], ...], re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]

classmethod focusInEvent(self, a0: QFocusEvent | None)

classmethod focusNextChild(self) → bool

classmethod focusNextPrevChild(self, next: bool) → bool

classmethod focusOutEvent(self, a0: QFocusEvent | None)

classmethod focusPolicy(self) → Qt.FocusPolicy

classmethod focusPreviousChild(self) → bool

classmethod focusProxy(self) → QWidget | None

classmethod focusWidget(self) → QWidget | None

classmethod font(self) → QFont

classmethod fontInfo(self) → QFontInfo

classmethod fontMetrics(self) → QFontMetrics

classmethod foregroundRole(self) → QPalette.ColorRole

classmethod frameGeometry(self) → QRect

classmethod frameRect(self) → QRect

classmethod frameShadow(self) → QFrame.Shadow

classmethod frameShape(self) → QFrame.Shape

classmethod frameSize(self) → QSize

classmethod frameStyle(self) → int

classmethod frameWidth(self) → int

classmethod geometry(self) → QRect

classmethod getRange(self, index: int)

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

classmethod grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())

classmethod grabKeyboard(self)

classmethod grabMouse(self)

classmethod grabMouse(self, a0: QCursor | Qt.CursorShape)

classmethod grabShortcut(self, key: QKeySequence | QKeySequence.StandardKey | str | None | int, context: Qt.ShortcutContext = Qt.WindowShortcut) → int

classmethod graphicsEffect(self) → QGraphicsEffect | None

classmethod graphicsProxyWidget(self) → QGraphicsProxyWidget | None

classmethod handle(self, index: int) → QSplitterHandle | None

classmethod handleWidth(self) → int

classmethod hasFocus(self) → bool

classmethod hasHeightForWidth(self) → bool

classmethod hasMouseTracking(self) → bool

classmethod hasTabletTracking(self) → bool

classmethod height(self) → int

classmethod heightForWidth(self, a0: int) → int

classmethod heightMM(self) → int

classmethod hide(self)

hideEvent(self, a0: QHideEvent | None)

classmethod indexOf(self, w: QWidget | None) → int

classmethod inherits(self, classname: str | None) → bool

classmethod initPainter(self, painter: QPainter | None)

classmethod initStyleOption(self, option: QStyleOptionFrame | None)

classmethod inputMethodEvent(self, a0: QInputMethodEvent | None)

classmethod inputMethodHints(self) → Qt.InputMethodHint

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

classmethod insertAction(self, before: QAction | None, action: QAction | None)

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

classmethod insertWidget(self, index: int, widget: QWidget | None)

classmethod installEventFilter(self, a0: QObject | None)

classmethod isActiveWindow(self) → bool

classmethod isAncestorOf(self, child: QWidget | None) → bool

classmethod isCollapsible(self, index: int) → bool

classmethod isEnabled(self) → bool

classmethod isEnabledTo(self, a0: QWidget | None) → bool

classmethod isFullScreen(self) → bool

classmethod isHidden(self) → bool

classmethod isLeftToRight(self) → bool

classmethod isMaximized(self) → bool

classmethod isMinimized(self) → bool

classmethod isModal(self) → bool

classmethod isQuickItemType(self) → bool

classmethod isRightToLeft(self) → bool

classmethod isSignalConnected(self, signal: QMetaMethod) → bool

classmethod isVisible(self) → bool

classmethod isVisibleTo(self, a0: QWidget | None) → bool

classmethod isWidgetType(self) → bool

classmethod isWindow(self) → bool

classmethod isWindowModified(self) → bool

classmethod isWindowType(self) → bool

keyPressEvent(event: QKeyEvent | None) → None

Called whenever a key is pressed.

Parameters:

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

keyReleaseEvent(event: QKeyEvent | None) → None

Called whenever a key is released.

Parameters:

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

classmethod keyboardGrabber() → QWidget | None

classmethod killTimer(self, id: int)

property layerButtons: QtLayerButtons

Button controls for napari layers.

property layer_to_visual: dict[Layer, VispyBaseLayer[Layer]]

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

property layers: QtLayerList

Qt view for LayerList controls.

classmethod layout(self) → QLayout | None

classmethod layoutDirection(self) → Qt.LayoutDirection

classmethod leaveEvent(self, a0: QEvent | None)

classmethod lineWidth(self) → int

classmethod locale(self) → QLocale

classmethod logicalDpiX(self) → int

classmethod logicalDpiY(self) → int

classmethod lower(self)

classmethod mapFrom(self, a0: QWidget | None, a1: QPoint) → QPoint

classmethod mapFrom(self, a0: QWidget | None, a1: QPointF) → QPointF

classmethod mapFromGlobal(self, a0: QPoint) → QPoint

classmethod mapFromGlobal(self, a0: QPointF) → QPointF

classmethod mapFromParent(self, a0: QPoint) → QPoint

classmethod mapFromParent(self, a0: QPointF) → QPointF

classmethod mapTo(self, a0: QWidget | None, a1: QPoint) → QPoint

classmethod mapTo(self, a0: QWidget | None, a1: QPointF) → QPointF

classmethod mapToGlobal(self, a0: QPoint) → QPoint

classmethod mapToGlobal(self, a0: QPointF) → QPointF

classmethod mapToParent(self, a0: QPoint) → QPoint

classmethod mapToParent(self, a0: QPointF) → QPointF

classmethod mask(self) → QRegion

classmethod maximumHeight(self) → int

classmethod maximumSize(self) → QSize

classmethod maximumWidth(self) → int

classmethod metaObject(self) → QMetaObject | None

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

classmethod midLineWidth(self) → int

classmethod minimumHeight(self) → int

classmethod minimumSize(self) → QSize

classmethod minimumSizeHint(self) → QSize

classmethod minimumWidth(self) → int

classmethod mouseDoubleClickEvent(self, a0: QMouseEvent | None)

classmethod mouseGrabber() → QWidget | None

classmethod mouseMoveEvent(self, a0: QMouseEvent | None)

classmethod mousePressEvent(self, a0: QMouseEvent | None)

classmethod mouseReleaseEvent(self, a0: QMouseEvent | None)

classmethod move(self, a0: QPoint)

classmethod move(self, ax: int, ay: int)

classmethod moveEvent(self, a0: QMoveEvent | None)

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

classmethod moveToThread(self, thread: QThread | None)

classmethod nativeEvent(self, eventType: QByteArray | bytes | bytearray | memoryview, message: PyQt6.sip.voidptr | None)

classmethod nativeParentWidget(self) → QWidget | None

classmethod nextInFocusChain(self) → QWidget | None

classmethod normalGeometry(self) → QRect

classmethod objectName(self) → str

classmethod opaqueResize(self) → bool

classmethod orientation(self) → Qt.Orientation

classmethod overrideWindowFlags(self, type: Qt.WindowType)

classmethod overrideWindowState(self, state: Qt.WindowState)

classmethod paintEngine(self) → QPaintEngine | None

classmethod paintEvent(self, a0: QPaintEvent | None)

classmethod paintingActive(self) → bool

classmethod palette(self) → QPalette

classmethod parent(self) → QObject | None

classmethod parentWidget(self) → QWidget | None

classmethod physicalDpiX(self) → int

classmethod physicalDpiY(self) → int

classmethod pos(self) → QPoint

classmethod previousInFocusChain(self) → QWidget | None

classmethod property(self, name: str | None) → Any

classmethod 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.

classmethod raise_(self)

classmethod receivers(self, signal: PYQT_SIGNAL) → int

classmethod rect(self) → QRect

classmethod refresh(self)

classmethod releaseKeyboard(self)

classmethod releaseMouse(self)

classmethod releaseShortcut(self, id: int)

classmethod removeAction(self, action: QAction | None)

classmethod removeEventFilter(self, a0: QObject | None)

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

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

classmethod repaint(self)

classmethod repaint(self, x: int, y: int, w: int, h: int)

classmethod repaint(self, a0: QRect)

classmethod repaint(self, a0: QRegion)

classmethod replaceWidget(self, index: int, widget: QWidget | None) → QWidget | None

classmethod resize(self, a0: QSize)

classmethod resize(self, w: int, h: int)

classmethod resizeEvent(self, a0: QResizeEvent | None)

resize_canvas(size: tuple[int, int] | None, scale: float) → Iterator[None]

Temporarily, safely, resize the canvas

Parameters:

• size ((int, int)) – New canvas size in pixels. Often calculated based on data size.

• scale (float) – Scale factor to modify final canvas size.

classmethod restoreGeometry(self, geometry: QByteArray | bytes | bytearray | memoryview) → bool

classmethod restoreState(self, state: QByteArray | bytes | bytearray | memoryview) → bool

classmethod saveGeometry(self) → QByteArray

classmethod saveState(self) → QByteArray

classmethod screen(self) → QScreen | None

screenshot(path: str | Path | None = None, flash: bool = True, size: tuple[int, int] | None = None, scale: float = 1.0, fit_to_data_extent: bool = False) → ndarray[tuple[int, int, Literal[4]], dtype[uint8]]

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.

• size (tuple[int, int]) – Size (resolution height x width) of the screenshot.

• scale (float) – Scale factor used to increase resolution of canvas for the screenshot. By default, the currently displayed resolution.

• fit_to_data_extent (bool) – Tightly fit the canvas around the data to prevent margins from showing in the screenshot. If False, a screenshot of the currently visible canvas will be generated.

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

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

classmethod scroll(self, dx: int, dy: int, a2: QRect)

classmethod sender(self) → QObject | None

classmethod senderSignalIndex(self) → int

classmethod setAcceptDrops(self, on: bool)

classmethod setAccessibleDescription(self, description: str | None)

classmethod setAccessibleIdentifier(self, identifier: str | None)

classmethod setAccessibleName(self, name: str | None)

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

classmethod setAutoFillBackground(self, enabled: bool)

classmethod setBackgroundRole(self, a0: QPalette.ColorRole)

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

classmethod setBaseSize(self, s: QSize)

classmethod setChildrenCollapsible(self, a0: bool)

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

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

classmethod setContentsMargins(self, margins: QMargins)

classmethod setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)

classmethod setCursor(self, a0: QCursor | Qt.CursorShape)

classmethod setDisabled(self, a0: bool)

classmethod setEnabled(self, a0: bool)

classmethod setFixedHeight(self, h: int)

classmethod setFixedSize(self, a0: QSize)

classmethod setFixedSize(self, w: int, h: int)

classmethod setFixedWidth(self, w: int)

classmethod setFocus(self)

classmethod setFocus(self, reason: Qt.FocusReason)

classmethod setFocusPolicy(self, policy: Qt.FocusPolicy)

classmethod setFocusProxy(self, a0: QWidget | None)

classmethod setFont(self, a0: QFont)

classmethod setForegroundRole(self, a0: QPalette.ColorRole)

classmethod setFrameRect(self, a0: QRect)

classmethod setFrameShadow(self, a0: QFrame.Shadow)

classmethod setFrameShape(self, a0: QFrame.Shape)

classmethod setFrameStyle(self, a0: int)

classmethod setGeometry(self, a0: QRect)

classmethod setGeometry(self, ax: int, ay: int, aw: int, ah: int)

classmethod setGraphicsEffect(self, effect: QGraphicsEffect | None)

classmethod setHandleWidth(self, a0: int)

classmethod setHidden(self, hidden: bool)

classmethod setInputMethodHints(self, hints: Qt.InputMethodHint)

classmethod setLayout(self, a0: QLayout | None)

classmethod setLayoutDirection(self, direction: Qt.LayoutDirection)

classmethod setLineWidth(self, a0: int)

classmethod setLocale(self, locale: QLocale)

classmethod setMask(self, a0: QBitmap)

classmethod setMask(self, a0: QRegion)

classmethod setMaximumHeight(self, maxh: int)

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

classmethod setMaximumSize(self, s: QSize)

classmethod setMaximumWidth(self, maxw: int)

classmethod setMidLineWidth(self, a0: int)

classmethod setMinimumHeight(self, minh: int)

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

classmethod setMinimumSize(self, s: QSize)

classmethod setMinimumWidth(self, minw: int)

classmethod setMouseTracking(self, enable: bool)

classmethod setObjectName(self, name: QByteArray | bytes | bytearray | memoryview | str | None)

classmethod setOpaqueResize(self, opaque: bool = True)

classmethod setOrientation(self, a0: Qt.Orientation)

classmethod setPalette(self, a0: QPalette)

classmethod setParent(self, parent: QWidget | None)

classmethod setParent(self, parent: QWidget | None, f: Qt.WindowType)

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

classmethod setRubberBand(self, position: int)

classmethod setScreen(self, a0: QScreen | None)

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

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

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

classmethod setSizeIncrement(self, s: QSize)

classmethod setSizePolicy(self, a0: QSizePolicy)

classmethod setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy)

classmethod setSizes(self, list: Iterable[int])

classmethod setStatusTip(self, a0: str | None)

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

classmethod setStyle(self, a0: QStyle | None)

classmethod setStyleSheet(self, styleSheet: str | None)

classmethod setTabOrder(a0: QWidget | None, a1: QWidget | None)

classmethod setTabletTracking(self, enable: bool)

classmethod setToolTip(self, a0: str | None)

classmethod setToolTipDuration(self, msec: int)

classmethod setUpdatesEnabled(self, enable: bool)

classmethod setVisible(self, visible: bool)

classmethod setWhatsThis(self, a0: str | None)

classmethod setWindowFilePath(self, filePath: str | None)

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

classmethod setWindowFlags(self, type: Qt.WindowType)

classmethod setWindowIcon(self, icon: QIcon)

classmethod setWindowIconText(self, a0: str | None)

classmethod setWindowModality(self, windowModality: Qt.WindowModality)

classmethod setWindowModified(self, a0: bool)

classmethod setWindowOpacity(self, level: float)

classmethod setWindowRole(self, a0: str | None)

classmethod setWindowState(self, state: Qt.WindowState)

classmethod setWindowTitle(self, a0: str | None)

set_welcome_tips(tips: Sequence[str] | None) → None

Replace the welcome screen tip pool.

classmethod sharedPainter(self) → QPainter | None

classmethod show(self)

showEvent(self, a0: QShowEvent | None)

classmethod showFullScreen(self)

classmethod showMaximized(self)

classmethod showMinimized(self)

classmethod showNormal(self)

property show_welcome_screen: bool

Whether to show the welcome screen when there are no layers.

Type:

bool

classmethod signalsBlocked(self) → bool

classmethod size(self) → QSize

classmethod sizeHint(self) → QSize

classmethod sizeIncrement(self) → QSize

classmethod sizePolicy(self) → QSizePolicy

classmethod sizes(self) → list[int]

classmethod stackUnder(self, a0: QWidget | None)

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

classmethod statusTip(self) → str

classmethod style(self) → QStyle | None

classmethod styleSheet(self) → str

classmethod tabletEvent(self, a0: QTabletEvent | None)

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

classmethod thread(self) → QThread | None

classmethod timerEvent(self, a0: QTimerEvent | None)

toggle_console_visibility(event: Event | None = None) → None

Toggle console visible and not visible.

Imports the console the first time it is requested.

classmethod toolTip(self) → str

classmethod toolTipDuration(self) → int

classmethod tr(sourceText: str | None, disambiguation: str | None = None, n: int = -1) → str

classmethod underMouse(self) → bool

classmethod ungrabGesture(self, type: Qt.GestureType)

classmethod unsetCursor(self)

classmethod unsetLayoutDirection(self)

classmethod unsetLocale(self)

classmethod update(self)

classmethod update(self, a0: QRect)

classmethod update(self, a0: QRegion)

classmethod update(self, ax: int, ay: int, aw: int, ah: int)

classmethod updateGeometry(self)

classmethod updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)

classmethod updatesEnabled(self) → bool

property viewerButtons: QtViewerButtons

Button controls for the napari viewer.

classmethod visibleRegion(self) → QRegion

classmethod whatsThis(self) → str

classmethod wheelEvent(self, a0: QWheelEvent | None)

classmethod widget(self, index: int) → QWidget | None

classmethod width(self) → int

classmethod widthMM(self) → int

classmethod winId(self) → PyQt6.sip.voidptr

classmethod window(self) → QWidget | None

classmethod windowFilePath(self) → str

classmethod windowFlags(self) → Qt.WindowType

classmethod windowHandle(self) → QWindow | None

classmethod windowIcon(self) → QIcon

classmethod windowIconText(self) → str

classmethod windowModality(self) → Qt.WindowModality

classmethod windowOpacity(self) → float

classmethod windowRole(self) → str

classmethod windowState(self) → Qt.WindowState

classmethod windowTitle(self) → str

classmethod windowType(self) → Qt.WindowType

classmethod x(self) → int

classmethod y(self) → int