cellestial.retrieve#
- retrieve(plot: PlotSpec | SupPlotsSpec, index: int = 0) DataFrame#
Retrieves the dataframe from a PlotSpec or SupPlotsSpec using the index.
- Parameters:
plot (
PlotSpec | SupPlotsSpec) – The plot to retrieve the dataframe from.index (
int, default0) – The index of the figure to retrieve the dataframe from.
- Returns:
DataFrame– The dataframe utilized in the plot.- Raises:
TypeError – If the plot is not a PlotSpec or SupPlotsSpec object.