graphinglib.MultiFigure.from_stack#

classmethod MultiFigure.from_stack(figures: list[Figure], size: tuple[float, float] | Inherit = Inherit, title: str | None = None, reference_labels: bool = True, reflabel_loc: str = 'outside', figure_style: str | Inherit = Inherit) → Self[source]#

Creates a MultiFigure with the specified Figure objects in a vertical configuration.

Parameters:

figureslist[Figure]: The Figure objects to add to the MultiFigure, from top to bottom.
sizetuple[float, float]: Overall size of the figure. Figure size is in inches; typical width is 4 to 12 and typical height is 3 to 8. Default depends on the figure_style configuration.
titlestr, optional: Title of the MultiFigure. Defaults to None.
reference_labelsbool: Whether or not to add reference labels to the SubFigures. Defaults to True.
reflabel_locstr: Location of the reference labels of the SubFigures. Values are "inside" and "outside". Defaults to "outside".
figure_stylestr: The figure style to use for the figure. Default can be set using gl.set_default_style().

Returns:

A new MultiFigure object.