graphinglib.MultiFigure.__init__#
- MultiFigure.__init__(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') None [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 individual
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 figure. 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()
.