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

mpl_toolkits.axes_grid1.axes_divider.AxesDivider

class mpl_toolkits.axes_grid1.axes_divider.AxesDivider(axes, xref=None, yref=None)[source]

Bases: mpl_toolkits.axes_grid1.axes_divider.Divider

Divider based on the pre-existing axes.

Parameters:
axes : Axes
xref
yref
append_axes(self, position, size, pad=None, add_to_figure=True, **kwargs)[source]

create an axes at the given position with the same height (or width) of the main axes.

position
["left"|"right"|"bottom"|"top"]

size and pad should be axes_grid.axes_size compatible.

get_anchor(self)[source]

return the anchor

get_aspect(self)[source]

return aspect

get_position(self)[source]

return the position of the rectangle.

get_subplotspec(self)[source]
new_horizontal(self, size, pad=None, pack_start=False, **kwargs)[source]

Add a new axes on the right (or left) side of the main axes.

Parameters:
size : axes_size or float or string

A width of the axes. If float or string is given, from_any function is used to create the size, with ref_size set to AxesX instance of the current axes.

pad : axes_size or float or string

Pad between the axes. It takes same argument as size.

pack_start : bool

If False, the new axes is appended at the end of the list, i.e., it became the right-most axes. If True, it is inserted at the start of the list, and becomes the left-most axes.

kwargs

All extra keywords arguments are passed to the created axes. If axes_class is given, the new axes will be created as an instance of the given class. Otherwise, the same class of the main axes will be used.

new_vertical(self, size, pad=None, pack_start=False, **kwargs)[source]

Add a new axes on the top (or bottom) side of the main axes.

Parameters:
size : axes_size or float or string

A height of the axes. If float or string is given, from_any function is used to create the size, with ref_size set to AxesX instance of the current axes.

pad : axes_size or float or string

Pad between the axes. It takes same argument as size.

pack_start : bool

If False, the new axes is appended at the end of the list, i.e., it became the right-most axes. If True, it is inserted at the start of the list, and becomes the left-most axes.

kwargs

All extra keywords arguments are passed to the created axes. If axes_class is given, the new axes will be created as an instance of the given class. Otherwise, the same class of the main axes will be used.