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:
figmatplotlib.figure.Figure
*argstuple (nrows, ncols, index) or int

The array of subplots in the figure has dimensions (nrows, ncols), and index is the index of the subplot being created. index starts at 1 in the upper left corner and increases to the right.

If nrows, ncols, and index are all single digit numbers, then args can be passed as a single 3-digit number (e.g. 234 for (2, 3, 4)).

__init__(self, fig, *args, horizontal=None, vertical=None, aspect=None, anchor='C')[source]
Parameters:
figmatplotlib.figure.Figure
*argstuple (nrows, ncols, index) or int

The array of subplots in the figure has dimensions (nrows, ncols), and index is the index of the subplot being created. index starts at 1 in the upper left corner and increases to the right.

If nrows, ncols, and index are all single digit numbers, then args can be passed as a single 3-digit number (e.g. 234 for (2, 3, 4)).

__module__ = 'mpl_toolkits.axes_grid1.axes_divider'
change_geometry(self, numrows, numcols, num)[source]

Change subplot geometry, e.g., from (1, 1, 1) to (2, 2, 3).

get_geometry(self)[source]

Get the subplot geometry, e.g., (2, 2, 3).

get_position(self)[source]

Return the bounds of the subplot box.

get_subplotspec(self)[source]

Get the SubplotSpec instance.

set_subplotspec(self, subplotspec)[source]

Set the SubplotSpec instance.

update_params(self)[source]

Update the subplot position from fig.subplotpars.

Examples using mpl_toolkits.axes_grid1.axes_divider.SubplotDivider