LineListTool
- class jdaviz.configs.default.LineListTool(*args, **kwargs)[source] [edit on github]
Bases:
jdaviz.core.template_mixin.TemplateMixin
Public constructor
Attributes Summary
An instance of a Python list.
A trait for unicode strings.
A trait for unicode strings.
A trait for unicode strings.
An instance of a Python list.
A boolean (True, False) trait.
An instance of a Python dict.
An instance of a Python list.
Methods Summary
vue_add_custom_line
(event)Add a line to the "Custom" line list from UI input
vue_change_visible
(line)Plot or erase a single line as needed when "Visible" checkbox is changed
vue_erase_all_lines
(event)Erase all lines from the viewer
vue_hide_all_in_list
(listname)Toggle all lines in list to be hidden
vue_list_selected
(event)Handle list selection from presets dropdown selector
vue_load_list
(event)Load one of the preset line lists, storing it's info in a vuetify-friendly manner in addition to loading the astropy table into the viewer's spectral_lines attribute.
vue_plot_all_lines
(event)Plot all the currently loaded lines in the viewer
vue_remove_line
(line[, erase])Method to remove a line from the plot when the line is deselected in the expansion panel content.
vue_remove_list
(listname)Method to remove line list from available expansion panels when the x on the panel header is clicked.
vue_set_color
(data)Change the color either of all members of a line list, or of an individual line.
vue_show_all_in_list
(listname)Toggle all lines in list to be visible
Attributes Documentation
- available_lists
An instance of a Python list.
- custom_name
A trait for unicode strings.
- custom_rest
A trait for unicode strings.
- custom_unit
A trait for unicode strings.
- dc_items
An instance of a Python list.
- dialog
A boolean (True, False) trait.
- list_contents
An instance of a Python dict.
One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.
Changed in version 5.0: Added key_trait for validating dict keys.
Changed in version 5.0: Deprecated ambiguous
trait
,traits
args in favor ofvalue_trait
,per_key_traits
.
- loaded_lists
An instance of a Python list.
- template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/v2.1.0/lib/python3.8/site-packages/jdaviz/configs/default/plugins/line_lists/line_lists.py', 'line_lists.vue')
Methods Documentation
- update_line_mark_dict()[source] [edit on github]
- vue_add_custom_line(event)[source] [edit on github]
Add a line to the “Custom” line list from UI input
- vue_change_visible(line)[source] [edit on github]
Plot or erase a single line as needed when “Visible” checkbox is changed
- vue_erase_all_lines(event)[source] [edit on github]
Erase all lines from the viewer
- vue_hide_all_in_list(listname)[source] [edit on github]
Toggle all lines in list to be hidden
- vue_list_selected(event)[source] [edit on github]
Handle list selection from presets dropdown selector
- vue_load_list(event)[source] [edit on github]
Load one of the preset line lists, storing it’s info in a vuetify-friendly manner in addition to loading the astropy table into the viewer’s spectral_lines attribute.
- vue_plot_all_lines(event)[source] [edit on github]
Plot all the currently loaded lines in the viewer
- vue_remove_line(line, erase=True)[source] [edit on github]
Method to remove a line from the plot when the line is deselected in the expansion panel content. Input must have “linename” and “rest” values for indexing on the astropy table.
- vue_remove_list(listname)[source] [edit on github]
Method to remove line list from available expansion panels when the x on the panel header is clicked. Also removes line marks from plot and updates the “show” value in the astropy table to False..
- vue_set_color(data)[source] [edit on github]
Change the color either of all members of a line list, or of an individual line.
- vue_show_all_in_list(listname)[source] [edit on github]
Toggle all lines in list to be visible