Update info about Canvas and Scene models - #1083
Merged
Merged
Conversation
github-actions
Bot
added
the
documentation
Contributor
Author
# References and relevant issues follow-up napari#1031 # Description Fix condition to use the current label name.
<!--pre-commit.ci start--> updates: - [github.com/astral-sh/ruff-pre-commit: v0.15.22 → v0.16.0](astral-sh/ruff-pre-commit@v0.15.22...v0.16.0) <!--pre-commit.ci end--> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
# Description NAPs are supposed to be Accepted, Widthdrawn or made Final when appropriate. We haven't been on top of this and several NAPs that have _effectively_ changed status were never formally changed. This PR does that, for those naps whose informal status is hopefully obvious :P Feel free to disagree below and I'll update accordingly, let's leave this open for a while! cc @napari/core-devs
<!--pre-commit.ci start--> updates: - [github.com/astral-sh/ruff-pre-commit: v0.16.0 → v0.16.1](astral-sh/ruff-pre-commit@v0.16.0...v0.16.1) <!--pre-commit.ci end--> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Tim Monko <timmonko@gmail.com>
brisvag
changed the title
TimMonko
reviewed
Aug 7, 2026
| - Scale bar (canvas overlay, accessible via `viewer.scale_bar`): it displays distances in world coordinates for the displayed scene. The scale bar usually inherits layer units when they are set. If inference fails it can fall back to a dimensionless label, and if displayed axes mix dimensionalities it uses the last displayed axis unit with a warning. You can control its appearance and fixed length from the viewer. See the [units guide](units-guide) for more information. | ||
| - 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. | ||
| Scene overlays live on `viewer.scene.overlays`: |
Member
There was a problem hiding this comment.
can you comment about layer-scene overlays / cross-link to them (like the bounding box)
Contributor
Author
There was a problem hiding this comment.
There's already a comment just below here in line 664!
Member
There was a problem hiding this comment.
ahh the problem with reading only the changed diff 🤦 sorry for the noise. Hopefully it's noticeable enough there :)
Co-authored-by: Tim Monko <timmonko@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
References and relevant issues
Description
Updates the information about the overlays, camera, and grid to the new locations, and adds some info about the canvas and scene models.