LayerSelect

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

Bases: SelectPluginComponent

Plugin select for layers, 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

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 in manual_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.

Attributes Summary

only_wcs_layers
selected_obj
viewer_objs

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

viewer_objs

Methods Documentation

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”). This method toggles the layer choices by adjusting the layer filters on this LayerSelect instance.

Parameters:

wcs_onlybool

True will filter only the WCS-only layers, False will give the non-WCS-only layers.