subgrids

subgrids(rows: int, cols: int, sub_cols: int, major_rows: tuple[int, ...] = (), titles: list = '', ylabels: list = '', xlabels: list = '', **kwargs) -> (<class 'matplotlib.figure.Figure'>, <class 'matplotlib.axes._axes.Axes'>)

Create a figure with subgrids

Parameters:

• rows (int) – The number of rows in the figure

• cols (int) – The number of columns in the figure

• sub_cols (int) – The number of columns in the subgrids

• major_rows (tuple[int, ], optional) – The rows that have major subgrids, by default ()

• titles (list, optional) – The titles for the subgrids, by default “”

• ylabels (list, optional) – The ylabels for the subgrids, by default “”

• xlabels (list, optional) – The xlabels for the subgrids, by default “”

• kwargs (dict) – Additional keyword arguments to pass to gridspec

Returns:

The figure and axes containing the subgrids

Return type:

(plt.Figure, plt.Axes)