TrayRegistry#
- class jdaviz.core.registries.TrayRegistry[source]#
Bases:
UniqueDictRegistry
Registry containing references to plugins that will be added to the sidebar tray tabs.
Attributes Summary
Methods Summary
__call__
([name, label, icon, ...])This is provided so that registry instances can be used as decorators.
add
(name, cls[, label, icon, ...])Add an item to the registry.
Attributes Documentation
- default_viewer_category = ['spectrum', 'table', 'image', 'spectrum-2d', 'flux', 'uncert', 'profile']#
- default_viewer_reqs = {'flux': {'cls_attr': '_default_flux_viewer_reference_name', 'init_kwarg': 'flux_viewer_reference_name', 'require_kwargs': ['require_flux_viewer']}, 'image': {'cls_attr': '_default_image_viewer_reference_name', 'init_kwarg': 'image_viewer_reference_name', 'require_kwargs': ['require_image_viewer']}, 'profile': {'cls_attr': '_default_profile_viewer_reference_name', 'init_kwarg': 'profile_viewer_reference_name', 'require_kwargs': ['require_profile_viewer']}, 'spectrum': {'cls_attr': '_default_spectrum_viewer_reference_name', 'init_kwarg': 'spectrum_viewer_reference_name', 'require_kwargs': ['require_spectrum_viewer']}, 'spectrum-2d': {'cls_attr': '_default_spectrum_2d_viewer_reference_name', 'init_kwarg': 'spectrum_2d_viewer_reference_name', 'require_kwargs': ['require_spectrum_2d_viewer']}, 'table': {'cls_attr': '_default_table_viewer_reference_name', 'init_kwarg': 'table_viewer_reference_name', 'require_kwargs': ['require_table_viewer']}, 'uncert': {'cls_attr': '_default_uncert_viewer_reference_name', 'init_kwarg': 'uncert_viewer_reference_name', 'require_kwargs': ['require_uncert_viewer']}}#
Methods Documentation
- __call__(name=None, label=None, icon=None, viewer_requirements=[], overwrite=False)[source]#
This is provided so that registry instances can be used as decorators. The decorators should add the decorated code object to the registry, and return the original function
- add(name, cls, label=None, icon=None, viewer_requirements=[], overwrite=False)[source]#
Add an item to the registry.
- Parameters:
- namestr
The key referencing the associated class in the registry dictionary.
- clstype
The class definition (not instance) associated with the name given in the first parameter.
- labelstr, optional
The label displayed in the tooltip when hovering over the tray tab.
- iconstr, optional
The name of the icon to render in the tray tab.
- viewer_requirementsstr, list of str
Required viewers for this plugin.
- overwritebool, optional
Whether to overwrite an existing entry with the same
label
.