FigureData

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

A plot data container.

Note

Raw figure data can be accessed through the FigureData.figure attribute.

Creates a new figure data object.

Parameters:

  • figure – The raw figure itself. Can be SVG or matplotlib.Figure.

  • name (str | None) – The name of the figure.

  • metadata (dict[str, Any] | None) – Any metadata to be stored with the figure.

Attributes

metadata

The metadata dictionary stored with the figure

name

The name of the figure

Methods

copy(new_name=None)[source]

Creates a copy of the figure data