AddResults

class jdaviz.core.template_mixin.AddResults(plugin, label, label_default, label_auto, label_invalid_msg, label_overwrite, add_to_viewer_items, add_to_viewer_selected, label_whitelist_overwrite=[])

Bases: BasePluginComponent

Plugin component for providing a data-label and selecting a viewer to add the results from the plugin.

Useful API methods/attributes:

• label (AutoTextField):

  the label component. Setting will redirect to setting label.value.

• auto

  shortcut to label.auto. Setting will redirect to setting label.auto.

• viewer (ViewerSelect):

  the viewer to add the results, or None to add the results to the data-collection but not load into a viewer.

Attributes Summary

auto	Access the auto property of the AutoTextField object.
label	Access the value of the AutoTextField object.
user_api

Methods Summary

add_results_from_plugin(data_item[, ...])

Add data_item to the app's data_collection according to the default or user-provided label and adds to any requested viewers.

Attributes Documentation

auto

Access the auto property of the AutoTextField object. If enabling, the label will automatically be changed and kept in sync with the default label.

label

Access the value of the AutoTextField object. Changing the value manually will also disable the auto option.

user_api

Methods Documentation

add_results_from_plugin(data_item, replace=None, label=None)

Add data_item to the app’s data_collection according to the default or user-provided label and adds to any requested viewers.