graphinglib.MultiFigure#

class graphinglib.MultiFigure(num_rows: int, num_cols: int, size: tuple[float, float] | Literal['default'] = 'default', title: str | None = None, reference_labels: bool = True, reflabel_loc: str = 'outside', figure_style: str = 'default')[source]#

This class implements the “canvas” on which multiple plots are displayed.

The canvas consists of a grid of a specified size on which the Figure objects are displayed.

Parameters:
num_rows, num_colsint

Number of rows and columns for the grid. These parameters determine the the number of “squares” on which a plot can be placed.

Note

Note that a single plot can span multiple squares. See add_SubFigure().

sizetuple[float, float]

Overall size of the multifigure. Default depends on the figure_style configuration.

titlestr, optional

General title of the figure.

reference_labelsbool

Whether or not to add reference labels to the SubFigures. Defaults to True.

Note

The reference labels are in the form of “a)”, “b)”, etc. and are used to refer to a particular SubFigure in a caption accompanying the MultiFigure.

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().

Methods

__init__(num_rows, num_cols[, size, title, ...])

This class implements the "canvas" on which multiple plots are displayed.

add_figure(figure, row_start, col_start, ...)

Adds a Figure to a MultiFigure.

from_grid(figures, dimensions[, size, ...])

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

from_row(figures[, size, title, ...])

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

from_stack(figures[, size, title, ...])

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

save(file_name[, general_legend, ...])

Saves the MultiFigure to a file.

set_rc_params([rc_params_dict, reset])

Customize the visual style of the MultiFigure.

set_visual_params([reset, ...])

Customize the visual style of the Figure.

show([general_legend, legend_loc, legend_cols])

Displays the MultiFigure.
On this page