SubsetPlugin
- class jdaviz.configs.default.plugins.subset_plugin.subset_plugin.SubsetPlugin(*args, **kwargs)[source] [edit on github]
Bases:
PluginTemplateMixin
,DatasetSelectMixin
Public constructor
Attributes Summary
An instance of a Python list.
A boolean (True, False) trait.
A boolean (True, False) trait.
A trait for unicode strings.
An instance of a Python list.
A boolean (True, False) trait.
A trait which allows any value.
An instance of a Python list.
An instance of a Python list.
A trait for unicode strings.
An instance of a Python list.
Methods Summary
Return the center of the Subset.
set_center
(new_cen[, update])Set the desired center for the selected Subset, if applicable.
vue_recenter_subset
(*args)vue_update_subset
(*args)Attributes Documentation
- glue_state_types
An instance of a Python list.
- has_subset_details
A boolean (True, False) trait.
- is_centerable
A boolean (True, False) trait.
- mode_selected
A trait for unicode strings.
- select
An instance of a Python list.
- show_region_info
A boolean (True, False) trait.
- subplugins_opened
A trait which allows any value.
- subset_definitions
An instance of a Python list.
- subset_items
An instance of a Python list.
- subset_selected
A trait for unicode strings.
- subset_types
An instance of a Python list.
- template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/v3.5.0/lib/python3.9/site-packages/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.py', 'subset_plugin.vue')
Methods Documentation
- get_center()[source] [edit on github]
Return the center of the Subset. This may or may not be the centroid obtain from data.
- set_center(new_cen, update=False)[source] [edit on github]
Set the desired center for the selected Subset, if applicable. If Subset is not centerable, nothing is done.
- Parameters:
- new_cennumber or tuple of numbers
The new center defined either as
x
or(x, y)
, depending on the Subset type.- updatebool
If
True
, the Subset is also moved to the new center. Otherwise, only the relevant editable fields are updated but the Subset is not moved.
- Raises:
- NotImplementedError
Subset type is not supported.
- vue_recenter_subset(*args)[source] [edit on github]
- vue_update_subset(*args)[source] [edit on github]