SelectPluginComponent#

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

Bases: BasePluginComponent, HasTraits

Plugin select, 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)

This extends BasePluginComponent for common functionality for a select/dropdown component. The subclasses MUST have an items traitlet as a list of dictionaries, with ‘label’ as the selection entry (and any other optional entries for styling, etc) and a selected string traitlet. The subclasses should also override selected_obj and may choose to override _selected_changed (likely with a super call to keep the base logic).

Attributes Summary

`allow_multiselect`
`cached_properties`
`choices`
`default_mode`
`default_text`
`filters`	An instance of a Python list.
`is_multiselect`
`labels`
`manual_options`
`selected_item`
`selected_item_list`
`selected_obj`
`viewer_dicts`
`viewer_ids`
`viewer_refs`
`viewers`

Methods Summary

`add_filter`(*filters)
`map_value`(attr, value)	Map the value being set to the traitlet.
`remove_filter`(*filters)
`select_all`()	Select (and return) all available options.
`select_default`()	Apply and return the default selection.
`select_next`()	Select next entry in the choices, wrapping when reaching the end.
`select_none`()	Select (and return) and empty list.
`select_previous`()	Apply and return the previous selection (or default option if no previous selection)

Attributes Documentation

allow_multiselect#

cached_properties#

choices#

default_mode#

default_text#

filters#: An instance of a Python list.

is_multiselect#

labels#

manual_options#

selected_item#

selected_item_list#

selected_obj#

viewer_dicts#

viewer_ids#

viewer_refs#

viewers#

Methods Documentation

add_filter(*filters)[source]#

map_value(attr, value)[source]#

Map the value being set to the traitlet. This is used to handle wildcard matching for the ‘selected’ traitlet when in multiselect mode. This method overrides the BasePluginComponent.map_value method.

Parameters:

attrstr: The name of the traitlet being set.
valueany: The value being set to the traitlet.

Returns:

valueany: The (possibly modified) value to be set to the traitlet.

remove_filter(*filters)[source]#

select_all()[source]#: Select (and return) all available options. Raises an error if not is_multiselect()

select_default()[source]#: Apply and return the default selection.

select_next()[source]#: Select next entry in the choices, wrapping when reaching the end. Raises an error if is_multiselect()

select_none()[source]#: Select (and return) and empty list. Raises an error if not is_multiselect()

select_previous()[source]#: Apply and return the previous selection (or default option if no previous selection)