matplotlib.figure.SubFigure — Matplotlib 3.10.1 documentation (original) (raw)

class matplotlib.figure.SubFigure(parent, subplotspec, *, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, **kwargs)[source]#

Logical figure that can be placed inside a figure.

See SubFigure for an index of methods on this class. Typically instantiated using Figure.add_subfigure orSubFigure.add_subfigure, or SubFigure.subfigures. A subfigure has the same methods as a figure except for those particularly tied to the size or dpi of the figure, and is confined to a prescribed region of the figure. For example the following puts two subfigures side-by-side:

fig = plt.figure() sfigs = fig.subfigures(1, 2) axsL = sfigs[0].subplots(1, 2) axsR = sfigs[1].subplots(2, 1)

See Figure subfigures

Parameters:

parentFigure or SubFigure

Figure or subfigure that contains the SubFigure. SubFigures can be nested.

subplotspecgridspec.SubplotSpec

Defines the region in a parent gridspec where the subfigure will be placed.

facecolordefault: "none"

The figure patch face color; transparent by default.

edgecolordefault: [rcParams["figure.edgecolor"]](../../users/explain/customizing.html?highlight=figure.edgecolor#matplotlibrc-sample) (default: 'white')

The figure patch edge color.

linewidthfloat

The linewidth of the frame (i.e. the edge linewidth of the figure patch).

frameonbool, default: [rcParams["figure.frameon"]](../../users/explain/customizing.html?highlight=figure.frameon#matplotlibrc-sample) (default: True)

If False, suppress drawing the figure background patch.

Other Parameters:

**kwargsSubFigure properties, optional