mpl_toolkits.axes_grid1.axes_divider.AxesDivider

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

Divider based on the pre-existing axes.

Parameters:	axes`Axes` xref yref

__init__(axes, xref=None, yref=None)[source]

Parameters:	axes`Axes` xref yref

append_axes(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.

size and pad should be axes_grid.axes_size compatible.

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

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

Parameters:

Parameters:	size`axes_size` or float or str 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 str Pad between the axes. It takes same argument as size. pack_startbool 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.

sizeaxes_size or float or str: 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.
padaxes_size or float or str: Pad between the axes. It takes same argument as size.
pack_startbool: 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(size, pad=None, pack_start=False, **kwargs)[source]

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

Parameters:

Parameters:	size`axes_size` or float or str 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 str Pad between the axes. It takes same argument as size. pack_startbool 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.

sizeaxes_size or float or str: 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.
padaxes_size or float or str: Pad between the axes. It takes same argument as size.
pack_startbool: 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.

Examples using `mpl_toolkits.axes_grid1.axes_divider.AxesDivider`

© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/_as_gen/mpl_toolkits.axes_grid1.axes_divider.AxesDivider.html