Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/guides/layers.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,17 @@ For example, the image below shows an image with the blending set to `additive`.

![napari viewer with an image of a cell. Layer controls are open in the left sidebar with the blending set to additive.](../_static/images/blending.png)

## 3D rendering of images
(layer-overlays)=
## Layer overlays

Following the same pattern as [viewer overlays](viewer-overlays), layers offer some extra visualisations as overlays:

- Bounding box (scene overlay, accessible via `layer.bounding_box`): displays a bounding box around the data
- Color bar (canvas overlay, accessible via `layer.colorbar` on layers with a `colormap` attribute): displays a colorbar legend with tickmarks, automatically synced with contrast limits

These overlays can be also toggled from the graphical interface by right-clicking on selected layers in the layerlist, and clicking their respective menu entry under **Visualisation**.

## 3D rendering

All our layers can be rendered in both 2D and 3D mode, and one of our viewer
buttons can toggle between each mode. The number of dimensions sliders will be 2
Expand Down
18 changes: 18 additions & 0 deletions docs/tutorials/fundamentals/viewer.md
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,24 @@ On the left side of the status bar there is a message about the position of the

The right side of the status bar contains some helpful tips depending on which layer and tools are currently selected.

(viewer-overlays)=
## Viewer overlays

Overlays provide additional information about the render state and the data, displayed on the canvas itself.
In napari there are two main types: canvas overlays - which are locked in position on the screen and hover over the rendered canvas - and scene overlays - which are located somewhere in world coordinates and follow the camera and dims just like layers. Canvas overlays can be positioned in various locations on the canvas (e.g: `top_left`, `bottom_center`), and will automatically tile if multiple are present at the same location.

The viewer gives access to a few such overlays:

- Scale bar (canvas overlay, accessible via `viewer.scale_bar`): you may set its unit, length, and other parameters.
- Axes (scene overlay, accessible via `viewer.axes`): displays basis axes at the origin.
- Text Overlay (canvas overlay, accessible via `viewer.text_overlay`): displays arbitrary text on the canvas.

These overlays can also be accessed via graphical interface through the **View** menu and their respective submenus.

:::{tip}
Similarly to the viewer, layers [also have some overlays](layer-overlays) that can be used to display layer-specific information!
:::

## Right-click menu

A context-sensitive menu is available when you right-click on any of the layers. The type of layer determines which options are available. Note that if you have multiple layers selected, the menu actions will affect all of the selected layers. The options that are not available for a layer are greyed out. The following options are available depending on which layer type you have selected:
Expand Down
Loading