API Reference

Information on specific functions, classes, and methods.

Modules

Primary

For the average user’s workflows.

napari.layers	Layers are the viewable objects that can be added to a viewer.
napari.view_layers	Methods to create a new viewer instance and add a particular layer type.
napari.types
napari.utils

Advanced

For those wishing to add custom functionality to their project.

napari.plugins
napari.components	napari.components provides the public-facing models for widgets and other utilities that the user will be able to programmatically interact with.
napari.qt.threading
napari.utils.perf	Performance Monitoring.

Starting the Event Loop

napari.gui_qt(*[, startup_logo, …])	Start a Qt event loop in which to run the application.
napari.run(*[, force, gui_exceptions, …])	Start the Qt Event Loop

Viewing a Layer

napari.view_image([data, channel_axis, rgb, …])	Create a viewer and add an image layer.
napari.view_labels(data, *[, num_colors, …])	Create a viewer and add a labels layer.
napari.view_path(path, *[, stack, plugin, …])	Create a viewer and add a path layer.
napari.view_points([data, ndim, properties, …])	Create a viewer and add a points layer.
napari.view_shapes([data, ndim, properties, …])	Create a viewer and add a shapes layer.
napari.view_surface(data, *[, colormap, …])	Create a viewer and add a surface layer.
napari.view_tracks(data, *[, properties, …])	Create a viewer and add a tracks layer.
napari.view_vectors(data, *[, properties, …])	Create a viewer and add a vectors layer.

napari.Viewer(*[, title, ndisplay, order, …])

Napari ndarray viewer.

Misc

napari.save_layers(path, layers, *[, plugin])	Write list of layers or individual layer to a path using writer plugins.
napari.sys_info([as_html])	Gathers relevant module versions for troubleshooting purposes.