graphinglib.MultiFigure.from_grid#

classmethod MultiFigure.from_grid(figures: list[Figure], dimensions: tuple[int, int], size: tuple[float, float] | Literal['default'] = 'default', title: str | None = None, reference_labels: bool = True, reflabel_loc: str = 'outside', figure_style: str = 'default') Self[source]#

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

Parameters:
figureslist[Figure]

The Figure objects to add to the MultiFigure, from top-left to bottom-right.

dimensionstuple[int, int]

The number of rows and columns of the grid (product should equal the number of figures).

sizetuple[float, float]

Overall size of the figure. 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. Either “inside” or “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.