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.

FigureData¶

class FigureData(figure, name=None, metadata=None)[source]¶

Wrapper class for figures and figure metadata. The raw figure can be accessed with the figure attribute.

Creates a new figure data object.

Parameters:

figure – the raw figure itself. Can be SVG or matplotlib.Figure.
name – Optional, the name of the figure.
metadata – Optional, any metadata to be stored with the figure.

Attributes

`FigureData.metadata`	The metadata dictionary stored with the figure
`FigureData.name`	The name of the figure

Methods

FigureData.copy([new_name])

Creates a copy of the figure data