Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

BasePlotter.set_supplementary_data

BasePlotter.set_supplementary_data(**data_kwargs)

Sets supplementary data for the plotter.

Supplementary data differs from series data in that it is not associate with a series name. Fit reports are examples of supplementary data as they contain fit results from an analysis class, such as the “goodness” of a curve fit.

Note that if data has already been assigned for the given data key, it will be overwritten with the new values. set_supplementary_data will warn if the data key is unexpected; i.e., not within those returned by expected_supplementary_data_keys().