matplotlib.figure.Figure.add_subplot #

Figure.add_subplot(*args,**kwargs)[source]#

Add anAxes 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), orSubplotSpec, default: (1, 1, 1)

The position of the subplot described by one of

Three integers (nrows,ncols,index). The subplot willtake theindex position on a grid withnrows rows andncols columns.index starts at 1 in the upper left cornerand increases to the right.index can also be a two-tuplespecifying the (first,last) indices (1-based, and includinglast) 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 givenseparately 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 usedif there are no more than 9 subplots.
ASubplotSpec.

In rare circumstances,add_subplot may be called with a singleargument, a subplot Axes instance already created in thepresent 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 thename of a custom projection, seeprojections. Thedefault None results in a 'rectilinear' projection.

polarbool, default: False

If True, equivalent to projection='polar'.

axes_classsubclass type ofAxes, optional

Theaxes.Axes subclass that is instantiated. This parameteris incompatible withprojection andpolar. Seeaxisartist for examples.

sharex, shareyAxes, optional

Share the x or yaxis with sharex and/or sharey.The axis will have the same limits, ticks, and scale as the axisof the shared Axes.

labelstr

A label for the returned Axes.

Returns:

Axes: The Axes of the subplot. The returned Axes can actually be aninstance of a subclass, such asprojections.polar.PolarAxes forpolar projections.

Other Parameters:

**kwargs

This method also takes the keyword arguments for the returned Axesbase class; except for thefigure argument. The keyword argumentsfor the rectilinear base classAxes can be found inthe following table but there might also be other keywordarguments if another projection is used.

Property	Description
`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 and two offsets from the bottom left corner of the image
`alpha`	float or None
`anchor`	(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} or float
`autoscale_on`	bool
`autoscalex_on`	unknown
`autoscaley_on`	unknown
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool or 'line'
`box_aspect`	float or None
`clip_box`	`BboxBase` or None
`clip_on`	bool
`clip_path`	Patch or (Path, Transform) or None
`facecolor` or`fc`	color
`figure`	`Figure` or`SubFigure`
`forward_navigation_events`	bool or "auto"
`frame_on`	bool
`gid`	str
`in_layout`	bool
`label`	object
`mouseover`	bool
`navigate`	bool
`navigate_mode`	unknown
`path_effects`	list of`AbstractPathEffect`
`picker`	None or bool or float or callable
`position`	[left, bottom, width, height] or`Bbox`
`prop_cycle`	`Cycler`
`rasterization_zorder`	float or None
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool or None
`subplotspec`	unknown
`title`	str
`transform`	`Transform`
`url`	str
`visible`	bool
`xbound`	(lower: float, upper: float)
`xinverted`	unknown
`xlabel`	str
`xlim`	(left: float, right: float)
`xmargin`	float greater than -0.5
`xscale`	unknown
`xticklabels`	unknown
`xticks`	unknown
`ybound`	(lower: float, upper: float)
`yinverted`	unknown
`ylabel`	str
`ylim`	(bottom: float, top: float)
`ymargin`	float greater than -0.5
`yscale`	unknown
`yticklabels`	unknown
`yticks`	unknown
`zorder`	float