pydox.commodities.PydoxFigure

class PydoxFigure(fig: matplotlib.figure.Figure, name: str, category: str = None, config_uid: str = None, caller: Callable | str = None, pickle: pathlib.Path = None, legend: str = None)

__init__(fig: Figure, name: str, category: str = None, config_uid: str = None, caller: Callable | str = None, pickle: Path = None, legend: str = None) → None

Methods

__init__(fig, name[, category, config_uid, ...])
reload()	Reload the pickle file with this figure object, and update the 'fig' attribute
show()	Call mpl.figure.Figure.show() on this instance figure object.

Attributes

caller	The function calling this instance
category	Category of the figure among pydox.commodities.VALID_FIGURE_CATEGORIES
config_uid	The configuration UID this figure is emanating from
legend	A string providing a legend for this figure
level	This figure level based on its category attribute
pickle	pathlib.Path to the pickle file where matplotlib.figure.Figure was saved by pydox.figures.commit()
uid	This instance uid, not to be confused with 'config_uid'
fig	matplotlib.figure.Figure instance
name	Name of the figure