SubsetPlugin#

class jdaviz.configs.default.plugins.subset_plugin.subset_plugin.SubsetPlugin(*args, **kwargs)[source]#

Public constructor

Attributes Summary

`can_freeze`	A boolean (True, False) trait.
`can_simplify`	A boolean (True, False) trait.
`glue_state_types`	An instance of a Python list.
`has_subset_details`	A boolean (True, False) trait.
`icon_and`	A trait for unicode strings.
`icon_andnot`	A trait for unicode strings.
`icon_checktoradial`	A trait for unicode strings.
`icon_or`	A trait for unicode strings.
`icon_radialtocheck`	A trait for unicode strings.
`icon_replace`	A trait for unicode strings.
`icon_xor`	A trait for unicode strings.
`is_centerable`	A boolean (True, False) trait.
`mode_selected`	A trait for unicode strings.
`multiselect`	A boolean (True, False) trait.
`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 which allows any value.
`subset_types`	An instance of a Python list.
`template_file`

Methods Summary

`get_center`([subset_name])	Return the center of the Subset.
`set_center`(new_cen[, subset_name, update])	Set the desired center for the selected Subset, if applicable.
`vue_freeze_subset`(*args)
`vue_recenter_subset`(*args)
`vue_simplify_subset`(*args)
`vue_update_subset`(*args)

Attributes Documentation

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/latest/lib/python3.11/site-packages/jdaviz/configs/default/plugins/subset_plugin/subset_plugin.py', 'subset_plugin.vue')#

Methods Documentation

get_center(subset_name=None)[source]#

Return the center of the Subset. This may or may not be the centroid obtain from data.

Parameters:

Returns:

cennumber, tuple of numbers, or None: The center of the Subset in x or (x, y), depending on the Subset type, if applicable. If Subset is not centerable, this returns None.

set_center(new_cen, subset_name=None, update=False)[source]#

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.
subset_namestr: The name of the subset that is being updated.
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: