PlotOptions

class jdaviz.configs.default.plugins.plot_options.plot_options.PlotOptions(*args, **kwargs)

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:

• show()

• open_in_tray()

• multiselect: whether viewer and layer should both be in multiselect mode.

• viewer (ViewerSelect):

• layer (LayerSelect):

• select_all()

• subset_visible (PlotOptionsSyncState): whether a subset should be visible.

• subset_color (PlotOptionsSyncState): not exposed for Specviz

• axes_visible (PlotOptionsSyncState): not exposed for Imviz

• collapse_function (PlotOptionsSyncState): only exposed for Cubeviz

• line_visible (PlotOptionsSyncState): not exposed for Imviz

• line_color (PlotOptionsSyncState): not exposed for Imviz

• line_width (PlotOptionsSyncState): not exposed for Imviz

• line_opacity (PlotOptionsSyncState): not exposed for Imviz

• line_as_steps (PlotOptionsSyncState): not exposed for Imviz

• uncertainty_visible (PlotOptionsSyncState): not exposed for Imviz

• stretch_function (PlotOptionsSyncState): not exposed for Specviz

• stretch_preset (PlotOptionsSyncState): not exposed for Specviz

• stretch_vmin (PlotOptionsSyncState): not exposed for Specviz

• stretch_vmax (PlotOptionsSyncState): not exposed for Specviz

• image_visible (PlotOptionsSyncState): whether the image bitmap is visible; not exposed for Specviz.

• image_color_mode (PlotOptionsSyncState): not exposed for Specviz

• image_color (PlotOptionsSyncState): not exposed for Specviz. This only applies when image_color_mode is “Monochromatic”.

• image_colormap (PlotOptionsSyncState): not exposed for Specviz. This only applies when image_color_mode is “Colormap”.

• image_opacity (PlotOptionsSyncState): not exposed for Specviz. Valid values are between 0 and 1, inclusive. Default is 1.

• image_contrast (PlotOptionsSyncState): not exposed for Specviz. Valid values are between 0 and 4, inclusive. Default is 1.

• image_bias (PlotOptionsSyncState): not exposed for Specviz. Valid values are between 0 and 1, inclusive. Default is 0.5.

• contour_visible (PlotOptionsSyncState): whether the contour is visible; not exposed for Specviz

• contour_mode (PlotOptionsSyncState): not exposed for Specviz

• contour_min (PlotOptionsSyncState): not exposed for Specviz. This only applies when contour_mode is “Linear”.

• contour_max (PlotOptionsSyncState): not exposed for Specviz. This only applies when contour_mode is “Linear”.

• contour_nlevels (PlotOptionsSyncState): not exposed for Specviz. This only applies when contour_mode is “Linear”.

• contour_custom_levels (PlotOptionsSyncState): not exposed for Specviz. This only applies when contour_mode is “Custom”.

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.
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_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.

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_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-javerbukh/envs/subset-refactor-part-1/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)

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)

vue_unmix_state(name)