feat: add widget visibility options to ArrayViewerModel (#139)

* feat: add set_options for ArrayViewer

* undo lock

* move to model

* fix tests

* use show

Author: tlambert03

src/ndv/controllers/_array_viewer.py

@@ -475,7 +475,7 @@ def _request_data(self) -> None:
             future.add_done_callback(self._on_data_response_ready)
 
         if self._futures:
-            self._view.set_progress_spinner_visible(True)
+            self._viewer_model.show_progress_spinner = True
 
     def _is_idle(self) -> bool:
         """Return True if no futures are running. Used for testing, and debugging."""
@@ -490,7 +490,7 @@ def _cancel_futures(self) -> None:
         while self._futures:
             self._futures.pop().cancel()
         self._futures.clear()
-        self._view.set_progress_spinner_visible(False)
+        self._viewer_model.show_progress_spinner = False
 
     @_app.ensure_main_thread
     def _on_data_response_ready(self, future: Future[DataResponse]) -> None:
@@ -499,7 +499,7 @@ def _on_data_response_ready(self, future: Future[DataResponse]) -> None:
         # which will prevent the widget from being garbage collected if the future
         self._futures.discard(future)
         if not self._futures:
-            self._view.set_progress_spinner_visible(False)
+            self._viewer_model.show_progress_spinner = False
 
         if future.cancelled():
             return

src/ndv/models/_viewer_model.py

@@ -1,7 +1,11 @@
 from enum import Enum, auto
+from typing import TYPE_CHECKING
 
 from ndv.models._base_model import NDVModel
 
+if TYPE_CHECKING:
+    from psygnal import Signal, SignalGroup
+
 
 class InteractionMode(Enum):
     """An enum defining graphical interaction mechanisms with an array Viewer."""
@@ -22,6 +26,40 @@ class ArrayViewerModel(NDVModel):
     ----------
     interaction_mode : InteractionMode
         Describes the current interaction mode of the Viewer.
+    show_3d_button : bool, optional
+        Whether to show the 3D button, by default True.
+    show_histogram_button : bool, optional
+        Whether to show the histogram button, by default True.
+    show_reset_zoom_button : bool, optional
+        Whether to show the reset zoom button, by default True.
+    show_roi_button : bool, optional
+        Whether to show the ROI button, by default True.
+    show_channel_mode_selector : bool, optional
+        Whether to show the channel mode selector, by default True.
+    show_progress_spinner : bool, optional
+        Whether to show the progress spinner, by default
     """
 
     interaction_mode: InteractionMode = InteractionMode.PAN_ZOOM
+    show_3d_button: bool = True
+    show_histogram_button: bool = True
+    show_reset_zoom_button: bool = True
+    show_roi_button: bool = True
+    show_channel_mode_selector: bool = True
+    show_progress_spinner: bool = False
+
+    if TYPE_CHECKING:
+        # just to make IDE autocomplete better
+        # it's still hard to indicate dynamic members in the events group
+        class ArrayViewerModelEvents(SignalGroup):
+            """Signal group for ArrayViewerModel."""
+
+            interaction_mode = Signal(InteractionMode, InteractionMode)
+            show_3d_button = Signal(bool, bool)
+            show_histogram_button = Signal(bool, bool)
+            show_reset_zoom_button = Signal(bool, bool)
+            show_roi_button = Signal(bool, bool)
+            show_channel_mode_selector = Signal(bool, bool)
+            show_progress_spinner = Signal(bool, bool)
+
+        events: ArrayViewerModelEvents = ArrayViewerModelEvents()  # type: ignore

src/ndv/views/_jupyter/_array_view.py

@@ -16,6 +16,7 @@
     from collections.abc import Container, Hashable, Iterator, Mapping, Sequence
 
     import cmap
+    from psygnal import EmissionInfo
     from traitlets import HasTraits
     from vispy.app.backends import _jupyter_rfb
 
@@ -156,7 +157,7 @@ def __init__(
         viewer_model: ArrayViewerModel,
     ) -> None:
         self._viewer_model = viewer_model
-        self._viewer_model.events.interaction_mode.connect(self._on_model_mode_changed)
+        self._viewer_model.events.connect(self._on_viewer_model_event)
         # WIDGETS
         self._data_model = data_model
         self._canvas_widget = canvas_widget
@@ -352,13 +353,6 @@ def _on_add_roi_button_toggle(self, change: dict[str, Any]) -> None:
             InteractionMode.CREATE_ROI if change["new"] else InteractionMode.PAN_ZOOM
         )
 
-    def _on_model_mode_changed(
-        self, new: InteractionMode, old: InteractionMode
-    ) -> None:
-        # If leaving CanvasMode.CREATE_ROI, uncheck the ROI button
-        if old == InteractionMode.CREATE_ROI:
-            self._add_roi_btn.value = False
-
     def add_histogram(self, widget: Any) -> None:
         """Add a histogram widget to the viewer."""
         warnings.warn("Histograms are not supported in Jupyter frontend", stacklevel=2)
@@ -409,5 +403,23 @@ def _on_reset_zoom_clicked(self, change: dict[str, Any]) -> None:
     def close(self) -> None:
         self.layout.close()
 
-    def set_progress_spinner_visible(self, visible: bool) -> None:
-        self._progress_spinner.layout.display = "flex" if visible else "none"
+    def _on_viewer_model_event(self, info: EmissionInfo) -> None:
+        sig_name = info.signal.name
+        value = info.args[0]
+        if sig_name == "show_progress_spinner":
+            self._progress_spinner.layout.display = "flex" if value else "none"
+        elif sig_name == "interaction_mode":
+            # If leaving CanvasMode.CREATE_ROI, uncheck the ROI button
+            new, old = info.args
+            if old == InteractionMode.CREATE_ROI:
+                self._add_roi_btn.value = False
+        elif sig_name == "show_histogram_button":
+            ...
+        elif sig_name == "show_roi_button":
+            self._add_roi_btn.layout.display = "flex" if value else "none"
+        elif sig_name == "show_channel_mode_selector":
+            self._channel_mode_combo.layout.display = "flex" if value else "none"
+        elif sig_name == "show_reset_zoom_button":
+            self._reset_zoom_btn.layout.display = "flex" if value else "none"
+        elif sig_name == "show_3d_button":
+            self._ndims_btn.layout.display = "flex" if value else "none"

src/ndv/views/_qt/_array_view.py

@@ -35,6 +35,7 @@
     from collections.abc import Container, Hashable, Mapping, Sequence
 
     import cmap
+    from psygnal import EmissionInfo
     from qtpy.QtGui import QIcon
 
     from ndv._types import AxisKey
@@ -451,7 +452,8 @@ def __init__(
         self._qwidget = qwdg = _QArrayViewer(canvas_widget)
         qwdg.histogram_btn.clicked.connect(self._on_add_histogram_clicked)
         qwdg.add_roi_btn.toggled.connect(self._on_add_roi_clicked)
-        self._viewer_model.events.interaction_mode.connect(self._on_model_mode_changed)
+
+        self._viewer_model.events.connect(self._on_viewer_model_event)
 
         # TODO: use emit_fast
         qwdg.dims_sliders.currentIndexChanged.connect(self.currentIndexChanged.emit)
@@ -484,13 +486,6 @@ def _on_add_histogram_clicked(self) -> None:
         else:
             self.histogramRequested.emit()
 
-    def _on_model_mode_changed(
-        self, new: InteractionMode, old: InteractionMode
-    ) -> None:
-        # If leaving CanvasMode.CREATE_ROI, uncheck the ROI button
-        if old == InteractionMode.CREATE_ROI:
-            self._qwidget.add_roi_btn.setChecked(False)
-
     def add_histogram(self, widget: QWidget) -> None:
         if hasattr(self, "_hist"):
             raise RuntimeError("Only one histogram can be added at a time")
@@ -565,10 +560,28 @@ def close(self) -> None:
     def frontend_widget(self) -> QWidget:
         return self._qwidget
 
-    def set_progress_spinner_visible(self, visible: bool) -> None:
-        self._qwidget._progress_spinner.setVisible(visible)
-
     def _on_add_roi_clicked(self, checked: bool) -> None:
         self._viewer_model.interaction_mode = (
             InteractionMode.CREATE_ROI if checked else InteractionMode.PAN_ZOOM
         )
+
+    def _on_viewer_model_event(self, info: EmissionInfo) -> None:
+        sig_name = info.signal.name
+        value = info.args[0]
+        if sig_name == "show_progress_spinner":
+            self._qwidget._progress_spinner.setVisible(value)
+        if sig_name == "interaction_mode":
+            # If leaving CanvasMode.CREATE_ROI, uncheck the ROI button
+            new, old = info.args
+            if old == InteractionMode.CREATE_ROI:
+                self._qwidget.add_roi_btn.setChecked(False)
+        elif sig_name == "show_histogram_button":
+            self._qwidget.histogram_btn.setVisible(value)
+        elif sig_name == "show_roi_button":
+            self._qwidget.add_roi_btn.setVisible(value)
+        elif sig_name == "show_channel_mode_selector":
+            self._qwidget.channel_mode_combo.setVisible(value)
+        elif sig_name == "show_reset_zoom_button":
+            self._qwidget.set_range_btn.setVisible(value)
+        elif sig_name == "show_3d_button":
+            self._qwidget.ndims_btn.setVisible(value)

src/ndv/views/_wx/_array_view.py

@@ -7,7 +7,7 @@
 import wx
 import wx.adv
 import wx.lib.newevent
-from psygnal import Signal
+from psygnal import EmissionInfo, Signal
 
 from ndv.models._array_display_model import ChannelMode
 from ndv.models._lut_model import ClimPolicy, ClimsManual, ClimsMinMax
@@ -86,7 +86,6 @@ class WxLutView(LutView):
     def __init__(self, parent: wx.Window) -> None:
         super().__init__()
         self._wxwidget = wdg = _WxLUTWidget(parent)
-        # TODO: use emit_fast
         wdg.visible.Bind(wx.EVT_CHECKBOX, self._on_visible_changed)
         wdg.cmap.Bind(wx.EVT_COMBOBOX, self._on_cmap_changed)
         wdg.clims.Bind(wx.EVT_SLIDER, self._on_clims_changed)
@@ -252,7 +251,7 @@ def __init__(self, canvas_widget: wx.Window, parent: wx.Window = None):
         )
 
         # Reset zoom button
-        self.reset_zoom_btn = wx.Button(self, label="Reset Zoom")
+        self.set_range_btn = wx.Button(self, label="Reset Zoom")
 
         # 3d view button
         self.ndims_btn = wx.ToggleButton(self, label="3D")
@@ -263,12 +262,12 @@ def __init__(self, canvas_widget: wx.Window, parent: wx.Window = None):
         # LUT layout (simple vertical grouping for LUT widgets)
         self.luts = wx.BoxSizer(wx.VERTICAL)
 
-        btns = wx.BoxSizer(wx.HORIZONTAL)
-        btns.AddStretchSpacer()
-        btns.Add(self.channel_mode_combo, 0, wx.ALL, 5)
-        btns.Add(self.reset_zoom_btn, 0, wx.ALL, 5)
-        btns.Add(self.ndims_btn, 0, wx.ALL, 5)
-        btns.Add(self.add_roi_btn, 0, wx.ALL, 5)
+        self._btns = wx.BoxSizer(wx.HORIZONTAL)
+        self._btns.AddStretchSpacer()
+        self._btns.Add(self.channel_mode_combo, 0, wx.ALL, 5)
+        self._btns.Add(self.set_range_btn, 0, wx.ALL, 5)
+        self._btns.Add(self.ndims_btn, 0, wx.ALL, 5)
+        self._btns.Add(self.add_roi_btn, 0, wx.ALL, 5)
 
         self._top_info = top_info = wx.BoxSizer(wx.HORIZONTAL)
         top_info.Add(self._data_info_label, 0, wx.EXPAND | wx.BOTTOM, 0)
@@ -281,7 +280,7 @@ def __init__(self, canvas_widget: wx.Window, parent: wx.Window = None):
         inner.Add(self._hover_info_label, 0, wx.EXPAND | wx.BOTTOM)
         inner.Add(self.dims_sliders, 0, wx.EXPAND | wx.BOTTOM)
         inner.Add(self.luts, 0, wx.EXPAND)
-        inner.Add(btns, 0, wx.EXPAND)
+        inner.Add(self._btns, 0, wx.EXPAND)
 
         outer = wx.BoxSizer(wx.VERTICAL)
         outer.Add(inner, 1, wx.EXPAND | wx.ALL, 10)
@@ -300,13 +299,13 @@ def __init__(
     ) -> None:
         self._data_model = data_model
         self._viewer_model = viewer_model
+        self._viewer_model.events.connect(self._on_viewer_model_event)
         self._wxwidget = wdg = _WxArrayViewer(canvas_widget, parent)
         self._visible_axes: Sequence[AxisKey] = []
 
-        # TODO: use emit_fast
         wdg.dims_sliders.currentIndexChanged.connect(self.currentIndexChanged.emit)
         wdg.channel_mode_combo.Bind(wx.EVT_COMBOBOX, self._on_channel_mode_changed)
-        wdg.reset_zoom_btn.Bind(wx.EVT_BUTTON, self._on_reset_zoom_clicked)
+        wdg.set_range_btn.Bind(wx.EVT_BUTTON, self._on_reset_zoom_clicked)
         wdg.ndims_btn.Bind(wx.EVT_TOGGLEBUTTON, self._on_ndims_toggled)
         wdg.add_roi_btn.Bind(wx.EVT_TOGGLEBUTTON, self._on_add_roi_toggled)
 
@@ -397,9 +396,29 @@ def set_visible(self, visible: bool) -> None:
     def close(self) -> None:
         self._wxwidget.Close()
 
-    def set_progress_spinner_visible(self, visible: bool) -> None:
-        if visible:
-            self._wxwidget._progress_spinner.Show()
+    def _on_viewer_model_event(self, info: EmissionInfo) -> None:
+        sig_name = info.signal.name
+        value = info.args[0]
+        if sig_name == "show_progress_spinner":
+            self._wxwidget._progress_spinner.Show(value)
             self._wxwidget._top_info.Layout()
-        else:
-            self._wxwidget._progress_spinner.Hide()
+        elif sig_name == "interaction_mode":
+            # If leaving CanvasMode.CREATE_ROI, uncheck the ROI button
+            new, old = info.args
+            if old == InteractionMode.CREATE_ROI:
+                self._wxwidget.add_roi_btn.SetValue(False)
+        elif sig_name == "show_histogram_button":
+            # _set_visible(self._wxwidget.histogram_btn, value)
+            ...
+        elif sig_name == "show_roi_button":
+            self._wxwidget.add_roi_btn.Show(value)
+            self._wxwidget._btns.Layout()
+        elif sig_name == "show_channel_mode_selector":
+            self._wxwidget.channel_mode_combo.Show(value)
+            self._wxwidget._btns.Layout()
+        elif sig_name == "show_reset_zoom_button":
+            self._wxwidget.set_range_btn.Show(value)
+            self._wxwidget._btns.Layout()
+        elif sig_name == "show_3d_button":
+            self._wxwidget.ndims_btn.Show(value)
+            self._wxwidget._btns.Layout()

src/ndv/views/bases/_array_view.py

@@ -74,6 +74,3 @@ def add_histogram(self, widget: Any) -> None:
 
     def remove_histogram(self, widget: Any) -> None:
         raise NotImplementedError
-
-    def set_progress_spinner_visible(self, visible: bool) -> None:
-        return

tests/conftest.py

@@ -33,7 +33,7 @@ def asyncio_app() -> Iterator[AbstractEventLoop]:
     loop.close()
 
 
-@pytest.fixture
+@pytest.fixture(scope="session")
 def wxapp() -> Iterator[wx.App]:
     import wx
 

tests/views/_jupyter/test_array_view.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+import ipywidgets
+from pytest import fixture
+
+from ndv.models._data_display_model import _ArrayDataDisplayModel
+from ndv.models._viewer_model import ArrayViewerModel
+from ndv.views._jupyter._array_view import JupyterArrayView
+
+
+@fixture
+def viewer() -> JupyterArrayView:
+    return JupyterArrayView(
+        ipywidgets.DOMWidget(), _ArrayDataDisplayModel(), ArrayViewerModel()
+    )
+
+
+def test_array_options(viewer: JupyterArrayView) -> None:
+    assert viewer._ndims_btn.layout.display is None
+    viewer._viewer_model.show_3d_button = False
+    assert viewer._ndims_btn.layout.display == "none"
+
+    assert viewer._reset_zoom_btn.layout.display is None
+    viewer._viewer_model.show_reset_zoom_button = False
+    assert viewer._reset_zoom_btn.layout.display == "none"
+
+    assert viewer._channel_mode_combo.layout.display is None
+    viewer._viewer_model.show_channel_mode_selector = False
+    assert viewer._channel_mode_combo.layout.display == "none"
+
+    assert viewer._add_roi_btn.layout.display is None
+    viewer._viewer_model.show_roi_button = False
+    assert viewer._add_roi_btn.layout.display == "none"

tests/views/_qt/conftest.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from pytest import fixture
+
+from ndv.views._qt._app import QtAppWrap
+
+
+@fixture(autouse=True)
+def init_provider() -> None:
+    provider = QtAppWrap()
+    provider.create_app()