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

mpl_toolkits.axes_grid1.axes_divider.VBoxDivider

class mpl_toolkits.axes_grid1.axes_divider.VBoxDivider(fig, *args, **kwargs)[source]

Bases: mpl_toolkits.axes_grid1.axes_divider.HBoxDivider

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

locate(nx, ny, nx1=None, ny1=None, axes=None, renderer=None)[source]
Parameters:
axes_divider : AxesDivider
nx, nx1 : int

Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.

ny, ny1 : int

Same as nx and nx1, but for row positions.

axes
renderer
new_locator(ny, ny1=None)[source]

returns a new locator (mpl_toolkits.axes_grid.axes_divider.AxesLocator) for specified cell.

Parameters:
ny, ny1 : int

Integers specifying the row-position of the cell. When ny1 is None, a single ny-th row is specified. Otherwise location of rows spanning between ny to ny1 (but excluding ny1-th row) is specified.