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:
multiselect
: whetherviewer
andlayer
should both be in multiselect mode.viewer
(ViewerSelect
):layer
(LayerSelect
):subset_visible
(PlotOptionsSyncState
): whether a subset should be visible.subset_color
(PlotOptionsSyncState
): not exposed for Specvizaxes_visible
(PlotOptionsSyncState
): not exposed for Imvizcollapse_function
(PlotOptionsSyncState
): only exposed for Cubevizline_visible
(PlotOptionsSyncState
): not exposed for Imvizline_color
(PlotOptionsSyncState
): not exposed for Imvizline_width
(PlotOptionsSyncState
): not exposed for Imvizline_opacity
(PlotOptionsSyncState
): not exposed for Imvizline_as_steps
(PlotOptionsSyncState
): not exposed for Imvizuncertainty_visible
(PlotOptionsSyncState
): not exposed for Imvizstretch_function
(PlotOptionsSyncState
): not exposed for Specvizstretch_preset
(PlotOptionsSyncState
): not exposed for Specvizstretch_vmin
(PlotOptionsSyncState
): not exposed for Specvizstretch_vmax
(PlotOptionsSyncState
): not exposed for Specvizimage_visible
(PlotOptionsSyncState
): whether the image bitmap is visible; not exposed for Specviz.image_color_mode
(PlotOptionsSyncState
): not exposed for Specvizimage_color
(PlotOptionsSyncState
): not exposed for Specviz. This only applies whenimage_color_mode
is “Monochromatic”.image_colormap
(PlotOptionsSyncState
): not exposed for Specviz. This only applies whenimage_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 Specvizcontour_mode
(PlotOptionsSyncState
): not exposed for Specvizcontour_min
(PlotOptionsSyncState
): not exposed for Specviz. This only applies whencontour_mode
is “Linear”.contour_max
(PlotOptionsSyncState
): not exposed for Specviz. This only applies whencontour_mode
is “Linear”.contour_nlevels
(PlotOptionsSyncState
): not exposed for Specviz. This only applies whencontour_mode
is “Linear”.contour_custom_levels
(PlotOptionsSyncState
): not exposed for Specviz. This only applies whencontour_mode
is “Custom”.
Public constructor
Attributes Summary
An instance of a Python dict.
A boolean (True, False) trait.
An instance of a Python dict.
A trait for unicode strings.
An instance of a Python dict.
A trait for unicode strings.
An instance of a Python list.
An instance of a Python dict.
A float trait.
An instance of a Python dict.
A float trait.
An instance of a Python dict.
A trait for unicode strings.
An instance of a Python dict.
An int trait.
An instance of a Python dict.
A boolean (True, False) trait.
A trait for unicode strings.
A trait for unicode strings.
An instance of a Python dict.
A float trait.
An instance of a Python dict.
A trait for unicode strings.
An instance of a Python dict.
A trait which allows any value.
An instance of a Python dict.
A trait for unicode strings.
An instance of a Python dict.
A float trait.
An instance of a Python dict.
A float trait.
An instance of a Python dict.
A boolean (True, False) trait.
An instance of a Python list.
A trait which allows any value.
An instance of a Python dict.
A boolean (True, False) trait.
An instance of a Python dict.
A trait which allows any value.
An instance of a Python dict.
A float trait.
An instance of a Python dict.
A boolean (True, False) trait.
An instance of a Python dict.
An int trait.
A boolean (True, False) trait.
A boolean (True, False) trait.
An instance of a Python dict.
A trait for unicode strings.
An instance of a Python dict.
A trait which allows any value.
An instance of a Python dict.
A float trait.
An instance of a Python dict.
A float trait.
An instance of a Python dict.
A trait for unicode strings.
An instance of a Python dict.
A boolean (True, False) trait.
An instance of a Python dict.
An int trait.
An instance of a Python list.
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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_trait
,per_key_traits
.
- contour_nlevels_value
An int 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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_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 ofvalue_trait
,per_key_traits
.
- subset_visible_value
A boolean (True, False) trait.
- template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/v3.0.2/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 ofvalue_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]