napari.qt.QtViewer

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

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

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)
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)
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)
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)
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	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
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

Bases: int

class RenderFlag

Bases: int

class RenderFlags

class RenderFlags(f: QWidget.RenderFlags | QWidget.RenderFlag)

class RenderFlags(a0: QWidget.RenderFlags)

Bases: 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 | None)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, action: QAction | None)

addActions(self, actions: Iterable[QAction])

addWidget(self, widget: QWidget | None)

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 | None)

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

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

childEvent(self, a0: QChildEvent | None)

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 | None)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

property controls: QtLayerControlsContainer

Qt view for GUI controls.

count(self) → int

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

createHandle(self) → QSplitterHandle | None

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

cursor(self) → QCursor

customEvent(self, a0: QEvent | None)

deleteLater(self)

depth(self) → int

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

devType(self) → int

devicePixelRatio(self) → int

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(a0: QMetaObject.Connection) → bool

disconnect(self) → None

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)

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 | None)

dragMoveEvent(self, a0: QDragMoveEvent | None)

drawFrame(self, a0: QPainter | None)

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 | None)

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

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

export_figure(path: str | None = None, scale: float = 1, flash=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)

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

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

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

findChild(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → QObjectT

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

findChildren(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObjectT]

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

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

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

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

focusInEvent(self, a0: QFocusEvent | None)

focusNextChild(self) → bool

focusNextPrevChild(self, next: bool) → bool

focusOutEvent(self, a0: QFocusEvent | None)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget | None

focusWidget(self) → QWidget | None

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)

getRange(self, index: int)

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

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

grabKeyboard(self)

grabMouse(self)

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

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

graphicsEffect(self) → QGraphicsEffect | None

graphicsProxyWidget(self) → QGraphicsProxyWidget | None

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

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 | None)

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

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

initPainter(self, painter: QPainter | None)

initStyleOption(self, option: QStyleOptionFrame | None)

inputMethodEvent(self, a0: QInputMethodEvent | None)

inputMethodHints(self) → Qt.InputMethodHints

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

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

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

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

installEventFilter(self, a0: QObject | None)

isActiveWindow(self) → bool

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

isCollapsible(self, index: int) → bool

isEnabled(self) → bool

isEnabledTo(self, a0: QWidget | None) → 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 | None) → 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 | None

killTimer(self, id: int)

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.

layout(self) → QLayout | None

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, a0: QEvent | None)

lineWidth(self) → int

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

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

mapFromGlobal(self, a0: QPoint) → QPoint

mapFromParent(self, a0: QPoint) → QPoint

mapTo(self, a0: QWidget | None, 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 | None

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 | None)

mouseGrabber() → QWidget | None

mouseMoveEvent(self, a0: QMouseEvent | None)

mousePressEvent(self, a0: QMouseEvent | None)

mouseReleaseEvent(self, a0: QMouseEvent | None)

move(self, a0: QPoint)

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

moveEvent(self, a0: QMoveEvent | None)

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

moveToThread(self, thread: QThread | None)

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

nativeParentWidget(self) → QWidget | None

nextInFocusChain(self) → QWidget | None

normalGeometry(self) → QRect

objectName(self) → str

opaqueResize(self) → bool

orientation(self) → Qt.Orientation

overrideWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)

overrideWindowState(self, state: Qt.WindowStates | Qt.WindowState)

paintEngine(self) → QPaintEngine | None

paintEvent(self, a0: QPaintEvent | None)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject | None

parentWidget(self) → QWidget | None

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

previousInFocusChain(self) → QWidget | None

property(self, name: str | None) → 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 | None)

removeEventFilter(self, a0: QObject | None)

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

render(self, painter: QPainter | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: 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 | None) → QWidget | None

resize(self, a0: QSize)

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

resizeEvent(self, a0: QResizeEvent | None)

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

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.

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

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

saveGeometry(self) → QByteArray

saveState(self) → QByteArray

screen(self) → QScreen | None

screenshot(path: str | 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

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

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

sender(self) → QObject | None

senderSignalIndex(self) → int

setAcceptDrops(self, on: bool)

setAccessibleDescription(self, description: str | None)

setAccessibleName(self, name: str | None)

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

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 | None)

setHandleWidth(self, a0: int)

setHidden(self, hidden: bool)

setInputMethodHints(self, hints: Qt.InputMethodHints | Qt.InputMethodHint)

setLayout(self, a0: QLayout | None)

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 | None)

setOpaqueResize(self, opaque: bool = True)

setOrientation(self, a0: Qt.Orientation)

setPalette(self, a0: QPalette)

setParent(self, parent: QWidget | None)

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

setProperty(self, name: str | None, 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 | None)

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

setStyle(self, a0: QStyle | None)

setStyleSheet(self, styleSheet: str | None)

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

setTabletTracking(self, enable: bool)

setToolTip(self, a0: str | None)

setToolTipDuration(self, msec: int)

setUpdatesEnabled(self, enable: bool)

setVisible(self, visible: bool)

setWhatsThis(self, a0: str | None)

setWindowFilePath(self, filePath: str | None)

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

setWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)

setWindowIcon(self, icon: QIcon)

setWindowIconText(self, a0: str | None)

setWindowModality(self, windowModality: Qt.WindowModality)

setWindowModified(self, a0: bool)

setWindowOpacity(self, level: float)

setWindowRole(self, a0: str | None)

setWindowState(self, state: Qt.WindowStates | Qt.WindowState)

setWindowTitle(self, a0: str | None)

set_welcome_visible(visible)

Show welcome screen widget.

sharedPainter(self) → QPainter | None

show(self)

showEvent(self, a0: QShowEvent | None)

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]

stackUnder(self, a0: QWidget | None)

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

statusTip(self) → str

style(self) → QStyle | None

styleSheet(self) → str

tabletEvent(self, a0: QTabletEvent | None)

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

thread(self) → QThread | None

timerEvent(self, a0: QTimerEvent | None)

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 | None, disambiguation: str | None = 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

property viewerButtons: QtViewerButtons

Button controls for the napari viewer.

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, a0: QWheelEvent | None)

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

width(self) → int

widthMM(self) → int

winId(self) → PyQt5.sip.voidptr

window(self) → QWidget | None

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

windowHandle(self) → QWindow | None

windowIcon(self) → QIcon

windowIconText(self) → str

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowStates

windowTitle(self) → str

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int