PlotOptions

class jdaviz.configs.default.plugins.plot_options.plot_options.PlotOptions(*args, **kwargs)[source] [edit on github]

Bases: PluginTemplateMixin

The Plot Options Plugin gives access to per-viewer and per-layer options and enables setting across multiple viewers/layers simultaneously.

Only the following attributes and methods are available through the public plugin API:

Public constructor

Attributes Summary

axes_visible_sync

An instance of a Python dict.

axes_visible_value

A boolean (True, False) trait.

collapse_func_sync

An instance of a Python dict.

collapse_func_value

A trait for unicode strings.

contour_custom_levels_sync

An instance of a Python dict.

contour_custom_levels_txt

A trait for unicode strings.

contour_custom_levels_value

An instance of a Python list.

contour_max_sync

An instance of a Python dict.

contour_max_value

A float trait.

contour_min_sync

An instance of a Python dict.

contour_min_value

A float trait.

contour_mode_sync

An instance of a Python dict.

contour_mode_value

A trait for unicode strings.

contour_nlevels_sync

An instance of a Python dict.

contour_nlevels_value

An int trait.

contour_spinner

A boolean (True, False) trait.

contour_visible_sync

An instance of a Python dict.

contour_visible_value

A boolean (True, False) trait.

icon_checktoradial

A trait for unicode strings.

icon_radialtocheck

A trait for unicode strings.

image_bias_sync

An instance of a Python dict.

image_bias_value

A float trait.

image_color_mode_sync

An instance of a Python dict.

image_color_mode_value

A trait for unicode strings.

image_color_sync

An instance of a Python dict.

image_color_value

A trait which allows any value.

image_colormap_sync

An instance of a Python dict.

image_colormap_value

A trait for unicode strings.

image_contrast_sync

An instance of a Python dict.

image_contrast_value

A float trait.

image_opacity_sync

An instance of a Python dict.

image_opacity_value

A float trait.

image_visible_sync

An instance of a Python dict.

image_visible_value

A boolean (True, False) trait.

layer_items

An instance of a Python list.

layer_selected

A trait which allows any value.

line_as_steps_sync

An instance of a Python dict.

line_as_steps_value

A boolean (True, False) trait.

line_color_sync

An instance of a Python dict.

line_color_value

A trait which allows any value.

line_opacity_sync

An instance of a Python dict.

line_opacity_value

A float trait.

line_visible_sync

An instance of a Python dict.

line_visible_value

A boolean (True, False) trait.

line_width_sync

An instance of a Python dict.

line_width_value

An int trait.

marker_color_col_sync

An instance of a Python dict.

marker_color_col_value

A trait for unicode strings.

marker_color_mode_sync

An instance of a Python dict.

marker_color_mode_value

A trait for unicode strings.

marker_color_sync

An instance of a Python dict.

marker_color_value

A trait which allows any value.

marker_colormap_sync

An instance of a Python dict.

marker_colormap_value

A trait for unicode strings.

marker_colormap_vmax_sync

An instance of a Python dict.

marker_colormap_vmax_value

A float trait.

marker_colormap_vmin_sync

An instance of a Python dict.

marker_colormap_vmin_value

A float trait.

marker_fill_sync

An instance of a Python dict.

marker_fill_value

A boolean (True, False) trait.

marker_opacity_sync

An instance of a Python dict.

marker_opacity_value

A float trait.

marker_size_col_sync

An instance of a Python dict.

marker_size_col_value

A trait for unicode strings.

marker_size_mode_sync

An instance of a Python dict.

marker_size_mode_value

A trait for unicode strings.

marker_size_scale_sync

An instance of a Python dict.

marker_size_scale_value

A float trait.

marker_size_sync

An instance of a Python dict.

marker_size_value

A float trait.

marker_size_vmax_sync

An instance of a Python dict.

marker_size_vmax_value

A float trait.

marker_size_vmin_sync

An instance of a Python dict.

marker_size_vmin_value

A float trait.

marker_visible_sync

An instance of a Python dict.

marker_visible_value

A boolean (True, False) trait.

multiselect

A boolean (True, False) trait.

show_viewer_labels

A boolean (True, False) trait.

stretch_function_sync

An instance of a Python dict.

stretch_function_value

A trait for unicode strings.

stretch_hist_zoom_limits

A boolean (True, False) trait.

stretch_histogram

A trait which allows any value.

stretch_preset_sync

An instance of a Python dict.

stretch_preset_value

A trait which allows any value.

stretch_vmax_sync

An instance of a Python dict.

stretch_vmax_value

A float trait.

stretch_vmin_sync

An instance of a Python dict.

stretch_vmin_value

A float trait.

subset_color_sync

An instance of a Python dict.

subset_color_value

A trait for unicode strings.

subset_visible_sync

An instance of a Python dict.

subset_visible_value

A boolean (True, False) trait.

template_file

uncertainty_visible_sync

An instance of a Python dict.

uncertainty_visible_value

An int trait.

user_api

viewer_items

An instance of a Python list.

viewer_selected

A trait which allows any value.

Methods Summary

select_all([viewers, layers])

Enable multiselect mode and select all viewers and/or layers.

vue_set_value(data)

vue_unmix_state(name)

Attributes Documentation

axes_visible_sync

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 of value_trait, per_key_traits.

axes_visible_value

A boolean (True, False) trait.

collapse_func_sync

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 of value_trait, per_key_traits.

collapse_func_value

A trait for unicode strings.

contour_custom_levels_sync

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 of value_trait, per_key_traits.

contour_custom_levels_txt

A trait for unicode strings.

contour_custom_levels_value

An instance of a Python list.

contour_max_sync

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 of value_trait, per_key_traits.

contour_max_value

A float trait.

contour_min_sync

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 of value_trait, per_key_traits.

contour_min_value

A float trait.

contour_mode_sync

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 of value_trait, per_key_traits.

contour_mode_value

A trait for unicode strings.

contour_nlevels_sync

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 of value_trait, per_key_traits.

contour_nlevels_value

An int trait.

contour_spinner

A boolean (True, False) trait.

contour_visible_sync

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 of value_trait, per_key_traits.

contour_visible_value

A boolean (True, False) trait.

icon_checktoradial

A trait for unicode strings.

icon_radialtocheck

A trait for unicode strings.

image_bias_sync

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 of value_trait, per_key_traits.

image_bias_value

A float trait.

image_color_mode_sync

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 of value_trait, per_key_traits.

image_color_mode_value

A trait for unicode strings.

image_color_sync

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 of value_trait, per_key_traits.

image_color_value

A trait which allows any value.

image_colormap_sync

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 of value_trait, per_key_traits.

image_colormap_value

A trait for unicode strings.

image_contrast_sync

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 of value_trait, per_key_traits.

image_contrast_value

A float trait.

image_opacity_sync

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 of value_trait, per_key_traits.

image_opacity_value

A float trait.

image_visible_sync

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 of value_trait, per_key_traits.

image_visible_value

A boolean (True, False) trait.

layer_items

An instance of a Python list.

layer_selected

A trait which allows any value.

line_as_steps_sync

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 of value_trait, per_key_traits.

line_as_steps_value

A boolean (True, False) trait.

line_color_sync

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 of value_trait, per_key_traits.

line_color_value

A trait which allows any value.

line_opacity_sync

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 of value_trait, per_key_traits.

line_opacity_value

A float trait.

line_visible_sync

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 of value_trait, per_key_traits.

line_visible_value

A boolean (True, False) trait.

line_width_sync

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 of value_trait, per_key_traits.

line_width_value

An int trait.

marker_color_col_sync

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 of value_trait, per_key_traits.

marker_color_col_value

A trait for unicode strings.

marker_color_mode_sync

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 of value_trait, per_key_traits.

marker_color_mode_value

A trait for unicode strings.

marker_color_sync

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 of value_trait, per_key_traits.

marker_color_value

A trait which allows any value.

marker_colormap_sync

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 of value_trait, per_key_traits.

marker_colormap_value

A trait for unicode strings.

marker_colormap_vmax_sync

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 of value_trait, per_key_traits.

marker_colormap_vmax_value

A float trait.

marker_colormap_vmin_sync

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 of value_trait, per_key_traits.

marker_colormap_vmin_value

A float trait.

marker_fill_sync

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 of value_trait, per_key_traits.

marker_fill_value

A boolean (True, False) trait.

marker_opacity_sync

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 of value_trait, per_key_traits.

marker_opacity_value

A float trait.

marker_size_col_sync

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 of value_trait, per_key_traits.

marker_size_col_value

A trait for unicode strings.

marker_size_mode_sync

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 of value_trait, per_key_traits.

marker_size_mode_value

A trait for unicode strings.

marker_size_scale_sync

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 of value_trait, per_key_traits.

marker_size_scale_value

A float trait.

marker_size_sync

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 of value_trait, per_key_traits.

marker_size_value

A float trait.

marker_size_vmax_sync

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 of value_trait, per_key_traits.

marker_size_vmax_value

A float trait.

marker_size_vmin_sync

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 of value_trait, per_key_traits.

marker_size_vmin_value

A float trait.

marker_visible_sync

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 of value_trait, per_key_traits.

marker_visible_value

A boolean (True, False) trait.

multiselect

A boolean (True, False) trait.

show_viewer_labels

A boolean (True, False) trait.

stretch_function_sync

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 of value_trait, per_key_traits.

stretch_function_value

A trait for unicode strings.

stretch_hist_zoom_limits

A boolean (True, False) trait.

stretch_histogram

A trait which allows any value.

stretch_preset_sync

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 of value_trait, per_key_traits.

stretch_preset_value

A trait which allows any value.

stretch_vmax_sync

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 of value_trait, per_key_traits.

stretch_vmax_value

A float trait.

stretch_vmin_sync

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 of value_trait, per_key_traits.

stretch_vmin_value

A float trait.

subset_color_sync

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 of value_trait, per_key_traits.

subset_color_value

A trait for unicode strings.

subset_visible_sync

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 of value_trait, per_key_traits.

subset_visible_value

A boolean (True, False) trait.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/v3.5.0/lib/python3.9/site-packages/jdaviz/configs/default/plugins/plot_options/plot_options.py', 'plot_options.vue')
uncertainty_visible_sync

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 of value_trait, per_key_traits.

uncertainty_visible_value

An int trait.

user_api
viewer_items

An instance of a Python list.

viewer_selected

A trait which allows any value.

Methods Documentation

select_all(viewers=True, layers=True)[source] [edit on github]

Enable multiselect mode and select all viewers and/or layers.

Parameters:
viewersbool

Whether to select all viewers (default: True)

layers: bool

Whether to select all layers (default: True)

vue_set_value(data)[source] [edit on github]
vue_unmix_state(name)[source] [edit on github]