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

This class calculates the axes position. It divides the given rectangular area into several sub-rectangles. You initialize the divider by setting the horizontal and vertical lists of sizes (mpl_toolkits.axes_grid.axes_size) that the division will be based on. You then use the new_locator method to create 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 if True, the 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(self, use_axes, pad=0.1, adjust_dirs=None) [source]

append_size(self, position, size) [source]

get_anchor(self) [source]

return the anchor

get_aspect(self) [source]

return aspect

get_horizontal(self) [source]

return horizontal sizes

get_horizontal_sizes(self, renderer) [source]

get_locator(self) [source]

get_position(self) [source]

return the position of the rectangle.

get_position_runtime(self, ax, renderer) [source]

get_vertical(self) [source]

return vertical sizes

get_vertical_sizes(self, renderer) [source]

get_vsize_hsize(self) [source]

locate(self, 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(self, nx, ny, nx1=None, ny1=None) [source]

Returns a new locator (mpl_toolkits.axes_grid.axes_divider.AxesLocator) for 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(self, anchor) [source]

Parameters:	anchor{'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W'} anchor position value description 'C' Center 'SW' bottom left 'S' bottom 'SE' bottom right 'E' right 'NE' top right 'N' top 'NW' top left 'W' left

set_aspect(self, aspect=False) [source]

Parameters:	aspectbool

set_horizontal(self, h) [source]

Parameters:	hlist of axes_size sizes for horizontal division

set_locator(self, _locator) [source]

set_position(self, pos) [source]

set the position of the rectangle.

Parameters:	postuple of 4 floats position of the rectangle that will be divided

set_vertical(self, v) [source]

Parameters:	vlist of axes_size sizes for vertical division