SubsetSelect

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

Bases: SelectPluginComponent

Plugin select for subsets, with support for single or multi-selection.

Useful API methods/attributes:

• choices()

• selected

• is_multiselect()

• select_default()

• select_all() (only if is_multiselect)

• select_none() (only if is_multiselect)

• selected_obj

• selected_subset_state

• selected_min_max()

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_optionslist

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.

filterslist

list of strings (for built-in filters) or callables to filter to only valid options.

Attributes Summary

selected_obj
selected_subset_mask
selected_subset_state

Methods Summary

selected_min_max(spectrum1d)

Attributes Documentation

selected_obj

selected_subset_mask

selected_subset_state

Methods Documentation

selected_min_max(spectrum1d)