SubsetSelect#

class jdaviz.core.template_mixin.SubsetSelect(**kwargs: Any)[source]#

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

Useful API methods/attributes:

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
multiselectstr: the name of the traitlet defining whether the dropdown should accept multiple selections
selected_has_subregionsstr: the name of the selected_has_subregions traitlet defined in plugin, optional
datasetstr: the name of the dataset traitlet defined in plugin, to be used for accessing how the subset is applied to the data (masks, etc), optional
viewerslist: the reference names or ids of the viewer to extract the subregion. If not provided or 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.
default_modestr, optional: What mode to use when making the default selection. Valid options: first, default_text, empty.
on_renamecallable: callback when an item is renamed, but before the selection is updated
on_removecallable: callback when an item is removed, but before the selection is updated

Attributes Summary

Methods Summary

`rename_choice`(old, new)	Rename an existing entry.
`selected_min_max`(dataset)	Get the min/max spectral range of `dataset` given the selected spectral subset

Attributes Documentation

Methods Documentation

rename_choice(old, new)[source]#

Rename an existing entry.

Parameters:

selected_min_max(dataset)[source]#: Get the min/max spectral range of dataset given the selected spectral subset