The Figure and SubFigure classes

Every visualization starts with a `~.Figure` class, often instantiated via `pyplot.figure`, `.pyplot.subplots`, or `.pyplot.subplot_mosaic`. It is possible to have `~.SubFigure` nested inside a `~.Figure`, so many common methods are defined in `~.FigureBase`.

.. seealso::

- :ref:`figures_and_backends`

- :ref:`arranging_axes`

.. plot::

fig = plt.figure(layout='constrained', figsize=(4, 2.5), facecolor='lightgoldenrodyellow')

# Make two subfigures, left ones more narrow than right ones:

sfigs = fig.subfigures(1, 2, width_ratios=[0.8, 1])

sfigs[0].set_facecolor('khaki')

sfigs[1].set_facecolor('lightsalmon')

# Add subplots to left subfigure:

lax = sfigs[0].subplots(2, 1)

sfigs[0].suptitle('Left subfigure')

# Add subplots to right subfigure:

rax = sfigs[1].subplots(1, 2)

sfigs[1].suptitle('Right subfigure')

# suptitle for the main figure:

fig.suptitle('Figure')

.. autosummary::

:toctree: _as_gen

:template: autosummary_class_only.rst

:nosignatures:

Figure

SubFigure

FigureBase

SubplotParams

Adding Axes and SubFigures

.. autosummary::

:toctree: _as_gen

:template: autosummary.rst

:nosignatures:

FigureBase.add_axes

FigureBase.add_subplot

FigureBase.subplots

FigureBase.subplot_mosaic

FigureBase.add_subfigure

FigureBase.subfigures

FigureBase.add_gridspec

SubFigure.axes

Figure.axes

Saving a Figure

.. autosummary::

:toctree: _as_gen

:template: autosummary.rst

:nosignatures:

Figure.savefig

Annotate (Sub)Figure

.. autosummary::

:toctree: _as_gen

:template: autosummary.rst

:nosignatures:

FigureBase.colorbar

FigureBase.legend

FigureBase.suptitle

FigureBase.get_suptitle

FigureBase.supxlabel

FigureBase.get_supxlabel

FigureBase.supylabel

FigureBase.get_supylabel

FigureBase.align_labels

FigureBase.align_xlabels

FigureBase.align_ylabels

Figure geometry and subplot layout

.. autosummary::

:toctree: _as_gen

:template: autosummary.rst

:nosignatures:

Figure.set_size_inches

Figure.get_size_inches

Figure.set_figheight

Figure.get_figheight

Figure.set_figwidth

Figure.get_figwidth

Figure.set_dpi

Figure.set_dpi

Figure.set_layout_engine

Figure.get_layout_engine

Interact with a Figure

.. seealso::

- :ref:`event-handling`

.. autosummary::

:toctree: _as_gen

:template: autosummary.rst

:nosignatures:

Figure.ginput

Figure.add_axobserver

Figure.waitforbuttonpress

Figure.pick

Modify (Sub)Figure appearance

.. autosummary::

:toctree: _as_gen

:template: autosummary.rst

:nosignatures:

FigureBase.set_frameon

FigureBase.get_frameon

FigureBase.set_linewidth

FigureBase.get_linewidth

FigureBase.set_facecolor

FigureBase.get_facecolor

FigureBase.set_edgecolor

FigureBase.get_edgecolor

Add and interrogate Artists on a (Sub)Figure

FigureBase.add_artist

FigureBase.get_children

Figure.figimage

Get and modify (Sub)Figure state

.. seealso::

- :ref:`interactive_figures`

.. autosummary::

:toctree: _as_gen

:template: autosummary.rst

:nosignatures:

Figure.clear

FigureBase.gca

FigureBase.sca

FigureBase.get_tightbbox

FigureBase.get_window_extent

Figure.show

Figure.set_canvas

Figure.draw

Figure.draw_without_rendering

Figure.draw_artist

Other

.. autosummary::

:toctree: _as_gen

:template: autosummary.rst

:nosignatures:

FigureBase.autofmt_xdate