PlotOptions

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

Bases: PluginTemplateMixin, ViewerSelectMixin

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()

• close_in_tray()

• viewer (ViewerSelect):

• viewer_multiselect

• layer (LayerSelect):

• layer_multiselect

• select_all()

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

• subset_color (PlotOptionsSyncState): not exposed for Specviz

• subset_opacity (PlotOptionsSyncState): not exposed for Specviz

• axes_visible (PlotOptionsSyncState): not exposed for Imviz

• 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

• stretch_hist_zoom_limits : whether to show the histogram for the current zoom limits instead of all data within the layer; not exposed for Specviz.

• stretch_hist_nbins : number of bins to use in creating the histogram; not exposed for Specviz.

• stretch_curve_visible : bool whether the stretch histogram’s colormap “curve” is visible; 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 “Color”.

• 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”.

• volume_level (PlotOptionsSyncState): not exposed for Specviz. Set the volume for the selected sonified layer.

• sonified_audible (PlotOptionsSyncState): not exposed for Specviz. Set if the selected sonified layer will output audio.

• xatt (PlotOptionsSyncState): only exposed for deconfigged. Controls the x-axis attribute for scatter and histogram plots.

• yatt (PlotOptionsSyncState): only exposed for deconfigged. Controls the y-axis attribute for scatter plots.

• hist_visible (PlotOptionsSyncState): only exposed for deconfigged. Whether histogram is visible.

• hist_color (PlotOptionsSyncState): only exposed for deconfigged. Controls histogram color.

• hist_opacity (PlotOptionsSyncState): only exposed for deconfigged. Controls histogram opacity.

• hist_xlog (PlotOptionsSyncState): only exposed for deconfigged. Controls x-axis log scaling for histograms.

• hist_ylog (PlotOptionsSyncState): only exposed for deconfigged. Controls y-axis log scaling for histograms.

• hist_n_bin (PlotOptionsSyncState): only exposed for deconfigged. Controls number of bins for histograms.

• hist_x_min (PlotOptionsSyncState): only exposed for deconfigged. Controls x-axis minimum value for histograms.

• hist_x_max (PlotOptionsSyncState): only exposed for deconfigged. Controls x-axis maximum value for histograms.

• hist_cumulative (PlotOptionsSyncState): only exposed for deconfigged. Controls cumulative histogram display.

• hist_normalize (PlotOptionsSyncState): only exposed for deconfigged. Controls histogram normalization.

• hist_update_bins_on_reset_limits (PlotOptionsSyncState): only exposed for deconfigged. Controls automatic bin updates when limits are reset.

• marker_visible (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Whether markers are visible.

• marker_fill (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker fill.

• marker_opacity (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker opacity.

• marker_size (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker size.

• marker_size_scale (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker size scaling.

• marker_color_mode (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker color mode.

• marker_color (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker color.

• marker_color_col (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker color column.

• marker_colormap (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker colormap.

• marker_colormap_vmin (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker colormap minimum value.

• marker_colormap_vmax (PlotOptionsSyncState): only exposed for Imviz and deconfigged. Controls marker colormap maximum value.

Public constructor

Attributes Summary

active_layer	A trait for unicode strings.
apply_RGB_presets_spinner	A boolean (True, False) trait.
axes_visible_sync	An instance of a Python dict.
axes_visible_value	A boolean (True, False) trait.
cmap_samples	An instance of a Python dict.
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.
display_units	An instance of a Python dict.
hist_color_sync	An instance of a Python dict.
hist_color_value	A trait which allows any value.
hist_cumulative_sync	An instance of a Python dict.
hist_cumulative_value	A boolean (True, False) trait.
hist_n_bin_sync	An instance of a Python dict.
hist_n_bin_value	An int trait.
hist_normalize_sync	An instance of a Python dict.
hist_normalize_value	A boolean (True, False) trait.
hist_opacity_sync	An instance of a Python dict.
hist_opacity_value	A float trait.
hist_update_bins_on_reset_limits_sync	An instance of a Python dict.
hist_update_bins_on_reset_limits_value	A boolean (True, False) trait.
hist_visible_sync	An instance of a Python dict.
hist_visible_value	A boolean (True, False) trait.
hist_x_max_sync	An instance of a Python dict.
hist_x_max_value	A float trait.
hist_x_min_sync	An instance of a Python dict.
hist_x_min_value	A float trait.
hist_xlog_sync	An instance of a Python dict.
hist_xlog_value	A boolean (True, False) trait.
hist_ylog_sync	An instance of a Python dict.
hist_ylog_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_multiselect	A boolean (True, False) trait.
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
sonified_audible_sync	An instance of a Python dict.
sonified_audible_value	A boolean (True, False) trait.
stretch_curve_visible	A boolean (True, False) trait.
stretch_function_sync	An instance of a Python dict.
stretch_function_value	A trait for unicode strings.
stretch_hist_nbins	Mixin to handle empty integer field.
stretch_hist_spinner	A boolean (True, False) trait.
stretch_hist_sync	An instance of a Python dict.
stretch_hist_zoom_limits	A boolean (True, False) trait.
stretch_histogram
stretch_histogram_widget	A trait for unicode strings.
stretch_params_sync	An instance of a Python dict.
stretch_params_value	An instance of a Python dict.
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.
stretch_vstep	A float trait.
subset_color_sync	An instance of a Python dict.
subset_color_value	A trait for unicode strings.
subset_opacity_sync	An instance of a Python dict.
subset_opacity_value	A float trait.
subset_visible_sync	An instance of a Python dict.
subset_visible_value	A boolean (True, False) trait.
swatches_palette	An instance of a Python list.
template_file
uncertainty_visible_sync	An instance of a Python dict.
uncertainty_visible_value	An int trait.
user_api
uses_active_status	A boolean (True, False) trait.
viewer_limits	An instance of a Python dict.
volume_sync	An instance of a Python dict.
volume_value	Mixin to handle empty integer field.
x_bound_step	A float trait.
x_max_sync	An instance of a Python dict.
x_max_value	A float trait.
x_min_sync	An instance of a Python dict.
x_min_value	A float trait.
xatt_sync	An instance of a Python dict.
xatt_value	A trait for unicode strings.
y_bound_step	A float trait.
y_max_sync	An instance of a Python dict.
y_max_value	A float trait.
y_min_sync	An instance of a Python dict.
y_min_value	A float trait.
yatt_sync	An instance of a Python dict.
yatt_value	A trait for unicode strings.
zoom_center_x_sync	An instance of a Python dict.
zoom_center_x_value	A float trait.
zoom_center_y_sync	An instance of a Python dict.
zoom_center_y_value	A float trait.
zoom_radius_sync	An instance of a Python dict.
zoom_radius_value	A float trait.
zoom_step	A float trait.

Methods Summary

apply_RGB_presets()	Applies preset colors, opacities, and stretch settings to all visible layers (in all viewers) when in Color (Monochromatic) mode.
image_segmentation_map_presets(*args, **kwargs)
reset_viewer_bounds()
select_all([viewers, layers])	Enable multiselect mode and select all viewers and/or layers.
set_histogram_limits([x_min, x_max, y_min, ...])
vue_apply_RGB_presets(data)
vue_image_segmentation_map_presets(*args, ...)
vue_reset_viewer_bounds(_)
vue_set_value(data)
vue_unmix_state(names)

Attributes Documentation

active_layer

A trait for unicode strings.

apply_RGB_presets_spinner

A boolean (True, False) trait.

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.

cmap_samples

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

display_units

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.

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

hist_color_value

A trait which allows any value.

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

hist_cumulative_value

A boolean (True, False) trait.

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

hist_n_bin_value

An int trait.

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

hist_normalize_value

A boolean (True, False) trait.

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

hist_opacity_value

A float trait.

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

hist_update_bins_on_reset_limits_value

A boolean (True, False) trait.

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

hist_visible_value

A boolean (True, False) trait.

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

hist_x_max_value

A float trait.

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

hist_x_min_value

A float trait.

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

hist_xlog_value

A boolean (True, False) trait.

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

hist_ylog_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_multiselect

A boolean (True, False) trait.

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

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

sonified_audible_value

A boolean (True, False) trait.

stretch_curve_visible

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_nbins

Mixin to handle empty integer field.

stretch_hist_spinner

A boolean (True, False) trait.

stretch_hist_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_hist_zoom_limits

A boolean (True, False) trait.

stretch_histogram

stretch_histogram_widget

A trait for unicode strings.

stretch_params_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_params_value

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

stretch_vstep

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

subset_opacity_value

A float trait.

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.

swatches_palette

An instance of a Python list.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/3978/lib/python3.11/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

uses_active_status

A boolean (True, False) trait.

viewer_limits

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.

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

volume_value

Mixin to handle empty integer field.

x_bound_step

A float trait.

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

x_max_value

A float trait.

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

x_min_value

A float trait.

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

xatt_value

A trait for unicode strings.

y_bound_step

A float trait.

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

y_max_value

A float trait.

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

y_min_value

A float trait.

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

yatt_value

A trait for unicode strings.

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

zoom_center_x_value

A float trait.

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

zoom_center_y_value

A float trait.

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

zoom_radius_value

A float trait.

zoom_step

A float trait.

Methods Documentation

apply_RGB_presets()

Applies preset colors, opacities, and stretch settings to all visible layers (in all viewers) when in Color (Monochromatic) mode.

image_segmentation_map_presets(*args, **kwargs)

reset_viewer_bounds()

select_all(viewers=True, layers=True)

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

Parameters:

viewersbool

Whether to set viewer_multiselect and select all viewers (default: True)

layers: bool

Whether to set layer_multiselect and select all layers (default: True)

set_histogram_limits(x_min=None, x_max=None, y_min=None, y_max=None)

vue_apply_RGB_presets(data)

vue_image_segmentation_map_presets(*args, **kwargs)

vue_reset_viewer_bounds(_)

vue_set_value(data)

vue_unmix_state(names)