SubsetSelect

class jdaviz.core.template_mixin.SubsetSelect(**kwargs: Any)

Bases: BaseSelectPluginComponent

Traitlets (in the object, custom traitlets in the plugin):

• items (list of dicts with keys: label, color, type)

• selected (string)

• selected_has_subregions (bool, OPTIONAL)

Properties (in the object only):

• labels (list of labels corresponding to items)

• selected_item (dictionary in items coresponding to selected, cached)

• selected_obj (subset object corresponding to selected, cached)

Methods (in the object only):

• selected_min_max(cube) (quantity, only applicable for spectral subsets)

To use in a plugin:

• create (empty) traitlets in the plugin

• register with all the automatic logic in the plugin’s init by passing the string names of the respective traitlets. Pass allowed_type='spectral' or allowed_type='spatial' to only support spectral or spatial subsets, respectively.

• use component in plugin template (see below)

• refer to properties above based on the interally stored reference to the instantiated object of this component

• observe the traitlets created and defined in the plugin, as necessary

Example template (label and hint are optional):

<plugin-subset-select
  :items="spectral_subset_items"
  :selected.sync="spectral_subset_selected"
  :show_if_single_entry="true"
  label="Subset"
  hint="Select subset."
/>

Parameters

plugin

the parent plugin object

itemsstr

the name of the items traitlet defined in plugin

selectedstr

the name of the selected traitlet defined in plugin

selected_has_subregions: str

the name of the selected_has_subregions traitlet defined in plugin, optional

viewerslist

the reference names or ids of the viewer to extract the subregion. If not provided o None, will loop through all references.

default_textstr or None

the text to show for no selection. If not provided or None, no entry will be provided in the dropdown for no selection.

manual_options: list

list of options to provide that are not automatically populated by subsets. If default text is provided but not in manual_options it will still be included as the first item in the list.

allowed_typestr or None

whether to filter to ‘spatial’ or ‘spectral’ types of subsets. If not provided or None, will include both entries.

Attributes Summary

selected_obj
selected_subset_state

Methods Summary

selected_min_max(spectrum1d)

Attributes Documentation

selected_obj

selected_subset_state

Methods Documentation

selected_min_max(spectrum1d)