SubsetSelect
- class jdaviz.core.template_mixin.SubsetSelect(**kwargs: Any)[source] [edit on github]
Bases:
SelectPluginComponent
Plugin select for subsets, with support for single or multi-selection.
Useful API methods/attributes:
selected
select_all()
(only ifis_multiselect
)select_none()
(only ifis_multiselect
)
- 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 inmanual_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
Methods Summary
selected_min_max
(spectrum1d)Attributes Documentation
- selected_obj
- selected_subset_mask
- selected_subset_state
Methods Documentation
- selected_min_max(spectrum1d)[source] [edit on github]