matplotlib.gridspec.SubplotSpec — Matplotlib 3.10.3 documentation (original) (raw)
class matplotlib.gridspec.SubplotSpec(gridspec, num1, num2=None)[source]#
Bases: object
The location of a subplot in a GridSpec.
Note
Likely, you will never instantiate a SubplotSpec yourself. Instead, you will typically obtain one from a GridSpec using item-access.
Parameters:
gridspecGridSpec
The GridSpec, which the subplot is referencing.
num1, num2int
The subplot will occupy the num1_-th cell of the given_gridspec. If num2 is provided, the subplot will span between_num1_-th cell and _num2_-th cell inclusive.
The index starts from 0.
property colspan#
The columns spanned by this subplot, as a range object.
Return the subplot geometry as tuple (n_rows, n_cols, start, stop).
The indices start and stop define the range of the subplot within the GridSpec. stop is inclusive (i.e. for a single cellstart == stop).
Update the subplot position from figure.subplotpars.
get_topmost_subplotspec()[source]#
Return the topmost SubplotSpec instance associated with the subplot.
property num2#
property rowspan#
The rows spanned by this subplot, as a range object.
subgridspec(nrows, ncols, **kwargs)[source]#
Create a GridSpec within this subplot.
The created GridSpecFromSubplotSpec will have this SubplotSpec as a parent.
Parameters:
nrowsint
Number of rows in grid.
ncolsint
Number of columns in grid.
Returns:
Other Parameters:
**kwargs
All other parameters are passed to GridSpecFromSubplotSpec.
Examples
Adding three subplots in the space occupied by a single subplot:
fig = plt.figure() gs0 = fig.add_gridspec(3, 1) ax1 = fig.add_subplot(gs0[0]) ax2 = fig.add_subplot(gs0[1]) gssub = gs0[2].subgridspec(1, 3) for i in range(3): fig.add_subplot(gssub[0, i])