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

BasePlotter.figure()

Generates and returns a figure for the already provided series and supplementary data.

figure() calls _plot_figure(), which is overridden by sub-classes. Before and after calling _plot_figure(); _configure_drawer(), initialize_canvas() and format_canvas() are called on the drawer respectively.

Return type:

Any

Returns:

A figure generated by drawer, of the same type as drawer.figure.