Merge pull request #2394 from meeseeksmachine/auto-backport-of-pr-234…

…4-on-v3.6.x

Backport PR #2344 on branch v3.6.x (multiselect support for dropdown default)

CHANGES.rst

@@ -7,6 +7,10 @@ Bug Fixes
 - Explot Plot now throws exception if its "save_figure" method is called
   with a path that contains invalid directory. [#2339]
 
+- Plugin dropdown elements with multiselect mode enabled will no longer reset
+  the selection when the choices change if any of the previous entries are still
+  valid. [#2344]
+
 Cubeviz
 ^^^^^^^
 

jdaviz/components/plugin_dataset_select.vue

@@ -1,6 +1,6 @@
 <template>
   <div>
-  <v-row v-if="items.length > 1 || show_if_single_entry">
+  <v-row v-if="items.length > 1 || selected.length===0 || show_if_single_entry">
     <v-select
       :menu-props="{ left: true }"
       attach

jdaviz/components/plugin_layer_select.vue

@@ -1,6 +1,6 @@
 <template>
   <div>
-  <v-row v-if="items.length > 1 || show_if_single_entry">
+  <v-row v-if="items.length > 1 || selected.length===0 || show_if_single_entry">
     <v-select
       :menu-props="{ left: true }"
       attach

jdaviz/components/plugin_subset_select.vue

@@ -1,6 +1,6 @@
 <template>
   <div>
-  <v-row v-if="items.length > 1 || show_if_single_entry">
+  <v-row v-if="items.length > 1 || selected.length===0 || show_if_single_entry">
     <v-select
       :menu-props="{ left: true }"
       attach

jdaviz/components/plugin_viewer_select.vue

@@ -1,6 +1,6 @@
 <template>
   <div>
-  <v-row v-if="items.length > 1 || show_if_single_entry">
+  <v-row v-if="items.length > 1 || selected.length===0 || show_if_single_entry">
     <v-select
       :menu-props="{ left: true }"
       attach

jdaviz/configs/default/plugins/plot_options/tests/test_plot_options.py

@@ -22,6 +22,11 @@ def test_multiselect(cubeviz_helper, spectrum1d_cube):
     assert po.layer.multiselect is True
 
     po.viewer.selected = ['flux-viewer', 'uncert-viewer']
+    # any internal call to reset the defaults (due to a change in the choices by adding or removing
+    # a viewer, etc) should not reset the selection
+    po.viewer._apply_default_selection(skip_if_current_valid=True)
+    assert po.viewer.selected == ['flux-viewer', 'uncert-viewer']
+
     # from API could call po.axes_visible.value = False, but we'll also test the vue-level wrapper
     po.vue_set_value({'name': 'axes_visible_value', 'value': False})
     assert po.axes_visible.value is False

jdaviz/configs/imviz/tests/test_viewers.py

@@ -25,8 +25,14 @@ def test_create_destroy_viewer(imviz_helper, desired_name, actual_name):
     # Make sure plugins that store viewer_items are updated.
     assert sorted(imviz_helper.plugins['Compass'].viewer.labels) == viewer_names
 
+    po = imviz_helper.plugins['Plot Options']
+    po.multiselect = True
+    po.viewer = viewer_names
+
     imviz_helper.destroy_viewer(actual_name)
     assert imviz_helper.app.get_viewer_ids() == ['imviz-0']
+    assert po.viewer.selected == ['imviz-0']
+    assert po.viewer.labels == ['imviz-0']
 
 
 def test_get_viewer_created(imviz_helper):

jdaviz/core/template_mixin.py

@@ -633,7 +633,18 @@ def default_mode(self):
         return self._default_mode
 
     def _apply_default_selection(self, skip_if_current_valid=True):
-        # TODO: make this multi-ready
+        if self.is_multiselect:
+            if skip_if_current_valid and len(self.selected) == 0:
+                # current selection is empty and so should remain that way
+                return
+            is_valid = [s in self.labels for s in self.selected]
+            if skip_if_current_valid and np.any(is_valid):
+                if np.all(is_valid):
+                    return
+                self.selected = [s for s in self.labels if s in self.selected]
+                return
+            is_valid = False
+
         is_valid = self.selected in self.labels
         if callable(self.default_mode):
             # callable was defined and passed by the plugin or inheriting component.