Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

data-menu: enforce layer order #3289

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+28 −9
Draft

data-menu: enforce layer order #3289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9443cfa
LayerSelect to support sort_by='zorder' or 'icon'
kecnry Nov 13, 2024
0869b57
sort data-menu, legend, and plot options tabs by z-order
kecnry Nov 13, 2024
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
6 changes: 3 additions & 3 deletions jdaviz/configs/default/plugins/data_menu/data_menu.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ def __init__(self, viewer, *args, **kwargs):
self.layer.remove_filter('filter_is_root')
self.layer.add_filter(is_not_wcs_only)
self.layer.multiselect = True
self.layer.sort_by = 'zorder'
self.layer._default_mode = 'empty'

# we'll use a modified version of the dataset mixin to have a filtered
Expand Down Expand Up @@ -218,8 +219,7 @@ def _dm_layer_selected_changed(self, event={}):
with self.during_select_sync():
# map index in dm_layer_selected (inverse order of layer_items)
# to set self.layer.selected
length = len(self.layer_items)
self.layer.selected = [self.layer_items[length-1-i]['label']
self.layer.selected = [self.layer_items[i]['label']
for i in self.dm_layer_selected]

@observe('layer_selected', 'layer_items')
Expand All @@ -229,7 +229,7 @@ def _layers_changed(self, event={}):
if not self._during_select_sync:
with self.during_select_sync():
# map list of strings in self.layer.selected to indices in dm_layer_selected
layer_labels = [layer['label'] for layer in self.layer_items][::-1]
layer_labels = [layer['label'] for layer in self.layer_items]
self.dm_layer_selected = [layer_labels.index(label) for label in self.layer.selected
if label in layer_labels]

Expand Down
4 changes: 2 additions & 2 deletions jdaviz/configs/default/plugins/data_menu/data_menu.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<span class="invert-if-dark" style="margin-left: 30px; margin-right: 36px; line-height: 28px">{{viewer_reference || viewer_id}}</span>
</div>

<div v-for="item in layer_items.slice().reverse()" class="viewer-label">
<div v-for="item in layer_items" class="viewer-label">
<div v-if="item.visible">
<span style="float: right">
<j-layer-viewer-icon-stylized
Expand Down Expand Up @@ -142,7 +142,7 @@
dense
>
<div>
<v-list-item v-for="item in layer_items.slice().reverse()">
<v-list-item v-for="item in layer_items">
<v-list-item-icon>
<j-layer-viewer-icon-stylized
:label="item.label"
Expand Down
3 changes: 2 additions & 1 deletion jdaviz/configs/default/plugins/plot_options/plot_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,8 @@ class PlotOptions(PluginTemplateMixin, ViewerSelectMixin):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.layer = LayerSelect(self, 'layer_items', 'layer_selected',
'viewer_selected', 'layer_multiselect')
'viewer_selected', 'layer_multiselect',
sort_by='zorder')

self.layer.filters += [is_not_wcs_only]

Expand Down
24 changes: 21 additions & 3 deletions jdaviz/core/template_mixin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1408,6 +1408,7 @@ class LayerSelect(SelectPluginComponent):
hint="Select layer."
/>
"""
sort_by = Unicode('icon').tag(sync=True)

def __init__(self, plugin, items, selected, viewer,
multiselect=None,
Expand All @@ -1416,7 +1417,8 @@ def __init__(self, plugin, items, selected, viewer,
only_wcs_layers=False,
is_root=True,
has_children=False,
is_child_of=None):
is_child_of=None,
sort_by='icon'):
"""
Parameters
----------
Expand All @@ -1439,6 +1441,8 @@ def __init__(self, plugin, items, selected, viewer,
default_mode : str, optional
What mode to use when making the default selection. Valid options: first, default_text,
empty.
sort_by : str, optional
How to sort the ordering of items. Valid options: zorder, icon
"""
super().__init__(plugin,
items=items,
Expand All @@ -1461,6 +1465,7 @@ def __init__(self, plugin, items, selected, viewer,
self.hub.subscribe(self, SubsetDeleteMessage,
handler=lambda _: self._update_layer_items())

self.sort_by = sort_by
self.app.state.add_callback('layer_icons', self._update_layer_items)
self.add_observe(viewer, self._on_viewer_selected_changed)
self.add_observe(selected, self._update_layer_items)
Expand Down Expand Up @@ -1539,6 +1544,7 @@ def not_trace(lyr):
def _layer_to_dict(self, layer_label):
is_subset = None
subset_type = None
zorder = None
from_plugin = None
live_plugin_results = None
colors = []
Expand All @@ -1552,6 +1558,8 @@ def _layer_to_dict(self, layer_label):
(hasattr(layer, 'layer') and hasattr(layer.layer, 'subset_state'))) # noqa
if is_subset:
subset_type = get_subset_type(layer.layer)
if zorder is None:
zorder = layer.state.zorder
if from_plugin is None:
from_plugin = layer.layer.data.meta.get('Plugin', None)
if live_plugin_results is None:
Expand All @@ -1570,6 +1578,7 @@ def _layer_to_dict(self, layer_label):
return {"label": layer_label,
"is_subset": is_subset,
"subset_type": subset_type,
"zorder": zorder,
"from_plugin": from_plugin,
"live_plugin_results": live_plugin_results,
"icon": self.app.state.layer_icons.get(layer_label),
Expand Down Expand Up @@ -1601,6 +1610,7 @@ def _on_viewer_selected_changed(self, msg=None):
if is_wcs_only(layer.layer):
continue
layer.remove_callback('color', self._update_layer_items)
layer.remove_callback('zorder', self._update_layer_items)
if hasattr(layer, 'cmap'):
layer.remove_callback('cmap', self._update_layer_items)
if hasattr(layer, 'bitmap_visible'):
Expand All @@ -1619,6 +1629,7 @@ def _on_viewer_selected_changed(self, msg=None):
if is_wcs_only(layer.layer):
continue
layer.add_callback('color', self._update_layer_items)
layer.add_callback('zorder', self._update_layer_items)
if hasattr(layer, 'cmap'):
layer.add_callback('cmap', self._update_layer_items)
if hasattr(layer, 'bitmap_visible'):
Expand Down Expand Up @@ -1663,7 +1674,7 @@ def _on_data_added(self, msg=None):

self._update_layer_items({'source': 'data_added'})

@observe('filters')
@observe('filters', 'sort_by')
def _update_layer_items(self, msg={}):
# NOTE: _on_layers_changed is passed without a msg object during init
# TODO: Handle changes to just one item without recompiling the whole thing
Expand Down Expand Up @@ -1691,7 +1702,14 @@ def _sort_by_icon(items_dict):
icon = items_dict['icon']
return icon if icon is not None else ''

layer_items.sort(key=_sort_by_icon)
def _sort_by_zorder(items_dict):
# NOTE: this works best if subscribed to a single viewer
return -1 * items_dict.get('zorder', 0)

if self.sort_by == 'zorder':
layer_items.sort(key=_sort_by_zorder)
else: # icon
layer_items.sort(key=_sort_by_icon)

self.items = manual_items + layer_items

Expand Down
Loading