mpl_toolkits.axes_grid1.axes_divider.Divider#

class mpl_toolkits.axes_grid1.axes_divider.Divider(fig, pos, horizontal, vertical, aspect=None, anchor='C')[source]#

Bases: object

An Axes positioning class.

The divider is initialized with lists of horizontal and vertical sizes (mpl_toolkits.axes_grid1.axes_size) based on which a given rectangular area will be divided.

The new_locator method then creates a callable object that can be used as the axes_locator of the axes.

Parameters
figFigure
postuple of 4 floats

Position of the rectangle that will be divided.

horizontallist of axes_size

Sizes for horizontal division.

verticallist of axes_size

Sizes for vertical division.

aspectbool

Whether overall rectangular area is reduced so that the relative part of the horizontal and vertical scales have the same scale.

anchor{'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W'}

Placement of the reduced rectangle, when aspect is True.

add_auto_adjustable_area(use_axes, pad=0.1, adjust_dirs=None)[source]#

Add auto-adjustable padding around use_axes to take their decorations (title, labels, ticks, ticklabels) into account during layout.

Parameters
use_axesAxes or list of Axes

The Axes whose decorations are taken into account.

padfloat, optional

Additional padding in inches.

adjust_dirslist of {"left", "right", "bottom", "top"}, optional

The sides where padding is added; defaults to all four sides.

append_size(position, size)[source]#
get_anchor()[source]#

Return the anchor.

get_aspect()[source]#

Return aspect.

get_horizontal()[source]#

Return horizontal sizes.

get_horizontal_sizes(renderer)[source]#
get_locator()[source]#
get_position()[source]#

Return the position of the rectangle.

get_position_runtime(ax, renderer)[source]#
get_vertical()[source]#

Return vertical sizes.

get_vertical_sizes(renderer)[source]#
get_vsize_hsize()[source]#

[Deprecated]

Notes

Deprecated since version 3.5:

locate(nx, ny, nx1=None, ny1=None, axes=None, renderer=None)[source]#
Parameters
nx, nx1int

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, ny1int

Same as nx and nx1, but for row positions.

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

Return a new AxesLocator for the specified cell.

Parameters
nx, nx1int

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, ny1int

Same as nx and nx1, but for row positions.

set_anchor(anchor)[source]#
Parameters
anchor(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}

Either an (x, y) pair of relative coordinates (0 is left or bottom, 1 is right or top), 'C' (center), or a cardinal direction ('SW', southwest, is bottom left, etc.).

See also

Axes.set_anchor
set_aspect(aspect=False)[source]#
Parameters
aspectbool
set_horizontal(h)[source]#
Parameters
hlist of axes_size

sizes for horizontal division

set_locator(_locator)[source]#
set_position(pos)[source]#

Set the position of the rectangle.

Parameters
postuple of 4 floats

position of the rectangle that will be divided

set_vertical(v)[source]#
Parameters
vlist of axes_size

sizes for vertical division