Implement toggling colorbar and bounding box in layerlist context menu by Czaki · Pull Request #8319 · napari/napari

Czaki · 2025-09-30T15:22:37Z

References and relevant issues

https://napari.zulipchat.com/#narrow/channel/215289-release/topic/0.2E6.2E5/near/542262710

Description

Add an option to control the visibility of colorbar and bounding box from layerlist context menu.

TimMonko

This works in the original PR as:
The right clicked layer must be the active layer (this is confusing to me!!!)

bounding box enabled only when 1 layer selected
colorbar enabled only when 1 layer selected and its an image or surface

I propose with my comments different behavior. I tested locally and found this to perform much closer to my expectation with both these features and similar layer list context items (which can perform on multiple layers)

bounding box enabled when any layers are selected, and will be toggled for all selected layers
colorbar enabled with any number of layers, as long as those layers are surface or image. will toggle for all selected layers

Even if we don't go with my proposed enablement, the callbacks can be used as I've proposed (though the for loop is unnecessary), because enablement already protects against the guards. We could add back the non-image/surface guard to present the warning and do enablement on any number of selected layers

Let me know if I'm missing something

TimMonko · 2025-09-30T15:31:54Z

+        MenuId.LAYERLIST_CONTEXT,
+        SubmenuItem(
+            submenu=MenuId.LAYERS_CONTEXT_VISUALIZATION,
+            title=trans._('Visualization'),


We could alternatively use "Overlays". I think either is ok, especially because we may want to add some kind of non-overlay visualization to this menu?

TimMonko · 2025-09-30T15:33:53Z

    ll.append(new)
+
+
+def _toogle_bounding_box(ll: LayerList) -> None:


Suggested change

def _toogle_bounding_box(ll: LayerList) -> None:

def _toggle_bounding_box(ll: LayerList) -> None:

TimMonko · 2025-09-30T15:35:18Z

+    Action(
+        id='napari.layer.bounding_box',
+        title=trans._('Bounding Box'),
+        callback=_layer_actions._toogle_bounding_box,


Suggested change

callback=_layer_actions._toogle_bounding_box,

callback=_layer_actions._toggle_bounding_box,

(method in _layer_actions needs updated as well)

TimMonko · 2025-09-30T15:41:20Z

+    if not (layer := ll.selection.active):
+        return
+
+    if not isinstance(layer, Image | Surface):
+        raise NotImplementedError(
+            trans._(
+                'Colorbar is only implemented for Images and Surfaces',
+                deferred=True,
+            )
+        )


This is all unnecessary because of the enablement, right? Why would we want this?

TimMonko · 2025-09-30T15:44:17Z

+            (LLSCK.num_selected_layers == 1)
+            & (
+                LLSCK.all_selected_layers_image
+                | LLSCK.all_selected_layers_surfaces
+            )


Suggested change

(LLSCK.num_selected_layers == 1)

& (

LLSCK.all_selected_layers_image

| LLSCK.all_selected_layers_surfaces

)

LLSCK.all_selected_layers_image

| LLSCK.all_selected_layers_surfaces

TimMonko · 2025-09-30T15:44:40Z

+                'id': MenuId.LAYERS_CONTEXT_VISUALIZATION,
+            }
+        ],
+        enablement=LLSCK.num_selected_layers == 1,


Suggested change

enablement=LLSCK.num_selected_layers == 1,

enablement=LLSCK.num_selected_layers > 0,

TimMonko · 2025-09-30T15:45:44Z

+    if not (layer := ll.selection.active):
+        return
+
+    if not isinstance(layer, Image | Surface):
+        raise NotImplementedError(
+            trans._(
+                'Colorbar is only implemented for Images and Surfaces',
+                deferred=True,
+            )
+        )
+    layer.colorbar.visible = not layer.colorbar.visible


Suggested change

if not (layer := ll.selection.active):

return

if not isinstance(layer, Image | Surface):

raise NotImplementedError(

trans._(

'Colorbar is only implemented for Images and Surfaces',

deferred=True,

)

)

layer.colorbar.visible = not layer.colorbar.visible

for layer in ll.selection:

layer.colorbar.visible = not layer.colorbar.visible

TimMonko · 2025-09-30T15:46:18Z

+    if not (layer := ll.selection.active):
+        return
+    layer.bounding_box.visible = not layer.bounding_box.visible


Suggested change

if not (layer := ll.selection.active):

return

layer.bounding_box.visible = not layer.bounding_box.visible

for layer in ll.selection

layer.bounding_box.visible = not layer.bounding_box.visible

codecov · 2025-09-30T16:47:37Z

Codecov Report

❌ Patch coverage is 82.35294% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.08%. Comparing base (4d44acc) to head (3a52d19).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
src/napari/layers/_layer_actions.py	57.14%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8319      +/-   ##
==========================================
+ Coverage   93.03%   93.08%   +0.05%     
==========================================
  Files         710      710              
  Lines       63989    64006      +17     
==========================================
+ Hits        59529    59581      +52     
+ Misses       4460     4425      -35

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Co-authored-by: Tim Monko <timmonko@gmail.com>

Czaki · 2025-09-30T19:30:53Z

+            raise NotImplementedError(
+                trans._(
+                    'Colorbar is only implemented for Images and Surfaces',
+                    deferred=True,
+                )
+            )


I keep this raise to have clean information about what goes wrong when our check do not properly limit layer selection.

TimMonko · 2025-09-30T19:35:52Z

+def _all_support_colorbar(s: LayerSel) -> bool:
+    return bool(s and all(hasattr(x, 'colorbar') for x in s))


really like this addition -- will be much clearer to support and allow custom layers to access!!!!

TimMonko · 2025-10-01T04:11:50Z

@brisvag I added highlight to this, I'll leave it up to you to add. We should at least add this new feature to the docs somewhere.

brisvag · 2025-10-01T10:18:38Z

I added the whole overlays shebang to the docs, should have done this a while back :P napari/docs#857

imagesc-bot · 2025-10-02T11:45:18Z

This pull request has been mentioned on Image.sc Forum. There might be relevant details there:

https://forum.image.sc/t/napari-v0-6-5-is-out/116715/1

implement toggling colorbar and bounding box

0c99f50

Czaki requested a review from a team as a code owner September 30, 2025 15:22

Czaki added the enhancement Improvement to pre-existing features label Sep 30, 2025

TimMonko changed the title ~~Implement toggling colorbar and bounding box in layelist context menu~~ Implement toggling colorbar and bounding box in layerlist context menu Sep 30, 2025

Czaki added this to the 0.6.5 milestone Sep 30, 2025

TimMonko reviewed Sep 30, 2025

View reviewed changes

Czaki and others added 2 commits September 30, 2025 21:27

apply review request

b190a89

Update src/napari/_app_model/context/_layerlist_context.py

2e35f53

Co-authored-by: Tim Monko <timmonko@gmail.com>

Czaki commented Sep 30, 2025

View reviewed changes

TimMonko approved these changes Sep 30, 2025

View reviewed changes

Apply suggestions from code review

610eb72

TimMonko added the ready to merge Last chance for comments! Will be merged in ~24h label Sep 30, 2025

go not crash if there is a colorbar

3a52d19

TimMonko merged commit 626528f into napari:main Oct 1, 2025
38 checks passed

github-actions Bot removed the ready to merge Last chance for comments! Will be merged in ~24h label Oct 1, 2025

TimMonko mentioned this pull request Oct 1, 2025

Investigate Layers menu to give GUI access to Layer.bounding_box.visible #7429

Closed

TimMonko added the highlight PR that should be mentioned in next release notes label Oct 1, 2025

TimMonko mentioned this pull request Oct 1, 2025

Add bounding box and colorbar layer list menu item to docs #8321

Closed

Czaki deleted the colorbar_enable branch October 2, 2025 07:34

		ll.append(new)


		def _toogle_bounding_box(ll: LayerList) -> None:

	def _toogle_bounding_box(ll: LayerList) -> None:
	def _toggle_bounding_box(ll: LayerList) -> None:

	callback=_layer_actions._toogle_bounding_box,
	callback=_layer_actions._toggle_bounding_box,

	enablement=LLSCK.num_selected_layers == 1,
	enablement=LLSCK.num_selected_layers > 0,

		def _all_support_colorbar(s: LayerSel) -> bool:
		return bool(s and all(hasattr(x, 'colorbar') for x in s))

Conversation

Czaki commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

References and relevant issues

Description

Uh oh!

TimMonko left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TimMonko commented Oct 1, 2025

Uh oh!

brisvag commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

imagesc-bot commented Oct 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Czaki commented Sep 30, 2025 •

edited

Loading

TimMonko left a comment •

edited

Loading

codecov Bot commented Sep 30, 2025 •

edited

Loading

brisvag commented Oct 1, 2025 •

edited

Loading