AddResultsMixin#

class jdaviz.core.template_mixin.AddResultsMixin(**kwargs: Any)[source]#

Bases: VuetifyTemplate, HubListener

Applies the AddResults component as a mixin in the base plugin. This automatically adds traitlets as well as new properties to the plugin with minimal extra code. For multiple instances or custom traitlet names/defaults, use the component instead.

To use in a plugin:

add AddResultsMixin as a mixin to the class
use the traitlets available from the plugin or properties/methods available from plugin.add_results.

Example template:

<plugin-add-results
  :label.sync="results_label"
  :label_default="results_label_default"
  :label_auto.sync="results_label_auto"
  :label_invalid_msg="results_label_invalid_msg"
  :label_overwrite="results_label_overwrite"
  label_hint="Label for the smoothed data"
  :add_to_viewer_items="add_to_viewer_items"
  :add_to_viewer_selected.sync="add_to_viewer_selected"
  :auto_update_result.sync="auto_update_result"
  action_label="Apply"
  action_tooltip="Apply the action to the data"
  @click:action="apply"
></plugin-add-results>

Public constructor

Attributes Summary

`add_to_viewer_items`	An instance of a Python list.
`add_to_viewer_selected`	A trait for unicode strings.
`auto_update_result`	A boolean (True, False) trait.
`results_label`	A trait for unicode strings.
`results_label_auto`	A boolean (True, False) trait.
`results_label_default`	A trait for unicode strings.
`results_label_invalid_msg`	A trait for unicode strings.
`results_label_overwrite`	A boolean (True, False) trait.

Attributes Documentation

add_to_viewer_items#: An instance of a Python list.

add_to_viewer_selected#: A trait for unicode strings.

auto_update_result#: A boolean (True, False) trait.

results_label#: A trait for unicode strings.

results_label_auto#: A boolean (True, False) trait.

results_label_default#: A trait for unicode strings.

results_label_invalid_msg#: A trait for unicode strings.

results_label_overwrite#: A boolean (True, False) trait.