matplotlib.figure.Figure.add_subplot — Matplotlib 3.10.8 documentation (original) (raw)
Figure.add_subplot(*args, **kwargs)[source]#
Add an Axes to the figure as part of a subplot arrangement.
Call signatures:
add_subplot(nrows, ncols, index, **kwargs) add_subplot(pos, **kwargs) add_subplot(ax) add_subplot()
Parameters:
*argsint, (int, int, index), or SubplotSpec, default: (1, 1, 1)
The position of the subplot described by one of
- Three integers (nrows, ncols, index). The subplot will take the index position on a grid with nrows rows and_ncols_ columns. index starts at 1 in the upper left corner and increases to the right. index can also be a two-tuple specifying the (first, last) indices (1-based, and including_last_) of the subplot, e.g.,
fig.add_subplot(3, 1, (1, 2))makes a subplot that spans the upper 2/3 of the figure. - A 3-digit integer. The digits are interpreted as if given separately as three single-digit integers, i.e.
fig.add_subplot(235)is the same asfig.add_subplot(2, 3, 5). Note that this can only be used if there are no more than 9 subplots. - A SubplotSpec.
In rare circumstances, add_subplot may be called with a single argument, a subplot Axes instance already created in the present figure but not in the figure's list of Axes.
projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional
The projection type of the subplot (Axes). str is the name of a custom projection, see projections. The default None results in a 'rectilinear' projection.
polarbool, default: False
If True, equivalent to projection='polar'.
axes_classsubclass type of Axes, optional
The axes.Axes subclass that is instantiated. This parameter is incompatible with projection and polar. Seeaxisartist for examples.
sharex, shareyAxes, optional
Share the x or y axis with sharex and/or sharey. The axis will have the same limits, ticks, and scale as the axis of the shared Axes.
labelstr
A label for the returned Axes.
Returns:
The Axes of the subplot. The returned Axes can actually be an instance of a subclass, such as projections.polar.PolarAxes for polar projections.
Other Parameters:
**kwargs
This method also takes the keyword arguments for the returned Axes base class; except for the figure argument. The keyword arguments for the rectilinear base class Axes can be found in the following table but there might also be other keyword arguments if another projection is used.
Examples
fig = plt.figure()
fig.add_subplot(231) ax1 = fig.add_subplot(2, 3, 1) # equivalent but more general
fig.add_subplot(232, frameon=False) # subplot with no frame fig.add_subplot(233, projection='polar') # polar subplot fig.add_subplot(234, sharex=ax1) # subplot sharing x-axis with ax1 fig.add_subplot(235, facecolor="red") # red subplot
ax1.remove() # delete ax1 from the figure fig.add_subplot(ax1) # add ax1 back to the figure