matplotlib 3.5.1

Other ParametersParametersReturnsBackRef
add_subplot(self, *args, **kwargs)

Call signatures:

add_subplot(nrows, ncols, index, **kwargs)
add_subplot(pos, **kwargs)
add_subplot(ax)
add_subplot()

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 :None:None:`~.axes.Axes` can be found in the following table but there might also be other keyword arguments if another projection is used.

Properties: adjustable: {'box', 'datalim'} agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alpha: scalar or None anchor: (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...} animated: bool aspect: {'auto', 'equal'} or float autoscale_on: bool autoscalex_on: bool autoscaley_on: bool axes_locator: Callable[[Axes, Renderer], Bbox] axisbelow: bool or 'line' box_aspect: float or None clip_box: .Bbox clip_on: bool clip_path: Patch or (Path, Transform) or None facecolor or fc: color figure: .Figure frame_on: bool gid: str in_layout: bool label: object navigate: bool navigate_mode: unknown path_effects: .AbstractPathEffect picker: None or bool or float or callable position: [left, bottom, width, height] or ~matplotlib.transforms.Bbox prop_cycle: unknown rasterization_zorder: float or None rasterized: bool sketch_params: (scale: float, length: float, randomness: float) snap: bool or None title: str transform: .Transform url: str visible: bool xbound: unknown xlabel: str xlim: (bottom: float, top: float) xmargin: float greater than -0.5 xscale: {"linear", "log", "symlog", "logit", ...} or .ScaleBase xticklabels: unknown xticks: unknown ybound: unknown ylabel: str ylim: (bottom: float, top: float) ymargin: float greater than -0.5 yscale: {"linear", "log", "symlog", "logit", ...} or .ScaleBase yticklabels: unknown yticks: unknown zorder: float

Parameters

*args : int, (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 as fig.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 (:None:None:`~.axes.Axes`). str is the name of a custom projection, see ~matplotlib.projections . The default None results in a 'rectilinear' projection.

polar : bool, default: False

If True, equivalent to projection='polar'.

axes_class : subclass type of `~.axes.Axes`, optional

The :None:None:`.axes.Axes` subclass that is instantiated. This parameter is incompatible with projection and polar. See axisartist_users-guide-index for examples.

sharex, sharey : `~.axes.Axes`, optional

Share the x or y ~matplotlib.axis with sharex and/or sharey. The axis will have the same limits, ticks, and scale as the axis of the shared axes.

label : str

A label for the returned Axes.

Returns

`.axes.SubplotBase`, or another subclass of `~.axes.Axes`

The Axes of the subplot. The returned Axes base class depends on the projection used. It is :None:None:`~.axes.Axes` if rectilinear projection is used and .projections.polar.PolarAxes if polar projection is used. The returned Axes is then a subplot subclass of the base class.

Add an :None:None:`~.axes.Axes` to the figure as part of a subplot arrangement.

See Also

.Figure.add_axes
.Figure.subplots
.pyplot.axes
.pyplot.subplot
.pyplot.subplots

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

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

matplotlib.pyplot.figure matplotlib.figure.FigureBase.add_subplot scipy.signal._filter_design.iirfilter matplotlib.pyplot.subplots matplotlib.figure.FigureBase._add_axes_internal papyri

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /matplotlib/figure.py#646
type: <class 'function'>
Commit: