You are reading an old version of the documentation (v3.0.2). For the latest version see https://matplotlib.org/stable/api/_as_gen/mpl_toolkits.axes_grid1.axes_divider.SubplotDivider.html
Version 3.0.2
matplotlib
Fork me on GitHub

mpl_toolkits.axes_grid1.axes_divider.SubplotDivider

class mpl_toolkits.axes_grid1.axes_divider.SubplotDivider(fig, *args, horizontal=None, vertical=None, aspect=None, anchor='C')[source]

Bases: mpl_toolkits.axes_grid1.axes_divider.Divider

The Divider class whose rectangle area is specified as a subplot geometry.

Parameters:
fig : matplotlib.figure.Figure
args : tuple (numRows, numCols, plotNum)

The array of subplots in the figure has dimensions numRows, numCols, and plotNum is the number of the subplot being created. plotNum starts at 1 in the upper left corner and increases to the right.

If numRows <= numCols <= plotNum < 10, args can be the decimal integer numRows * 100 + numCols * 10 + plotNum.

change_geometry(numrows, numcols, num)[source]

change subplot geometry, e.g., from 1,1,1 to 2,2,3

get_geometry()[source]

get the subplot geometry, e.g., 2,2,3

get_position()[source]

return the bounds of the subplot box

get_subplotspec()[source]

get the SubplotSpec instance

set_subplotspec(subplotspec)[source]

set the SubplotSpec instance

update_params()[source]

update the subplot position from fig.subplotpars