LayerSelect#
- class jdaviz.core.template_mixin.LayerSelect(**kwargs: Any)[source]#
Bases:
SelectPluginComponent
Plugin select for layers, 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
- viewer: str
the name of the traitlet defined in
plugin
storing the viewer(s) to expose the layers- 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 inmanual_options
it will still be included as the first item in the list.- default_modestr, optional
What mode to use when making the default selection. Valid options: first, default_text, empty.
- sort_bystr, optional
How to sort the ordering of items. Valid options: zorder (top layers are first), icon (alphabetical by icon, effectively by order in which layers were first added and assigned an icon)
Attributes Summary
A trait for unicode strings.
Methods Summary
update_wcs_only_filter
(wcs_only)The layers that are populated in LayerSelect.choices will be either WCS-only layers (for setting viewer orientation) or non-WCS-only layers (for "real data").
Attributes Documentation
- only_wcs_layers#
- selected_obj#
- sort_by#
A trait for unicode strings.
- viewer_objs#
Methods Documentation