mpl_toolkits.axes_grid.axes_divider
¶mpl_toolkits.axes_grid.axes_divider.
Divider
(fig, pos, horizontal, vertical, aspect=None, anchor='C')¶This is the class that is used 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: | fig : Figure pos : tuple of 4 floats
horizontal : list of
vertical : list of
aspect : bool
anchor : {‘C’, ‘SW’, ‘S’, ‘SE’, ‘E’, ‘NE’, ‘N’, ‘NW’, ‘W’}
|
---|
add_auto_adjustable_area
(use_axes, pad=0.1, adjust_dirs=None)¶append_size
(position, size)¶get_anchor
()¶return the anchor
get_aspect
()¶return aspect
get_horizontal
()¶return horizontal sizes
get_horizontal_sizes
(renderer)¶get_locator
()¶get_position
()¶return the position of the rectangle.
get_position_runtime
(ax, renderer)¶get_vertical
()¶return vertical sizes
get_vertical_sizes
(renderer)¶get_vsize_hsize
()¶locate
(nx, ny, nx1=None, ny1=None, axes=None, renderer=None)¶Parameters: | nx, nx1 : int
ny, ny1 : int
axes renderer |
---|
new_locator
(nx, ny, nx1=None, ny1=None)¶Returns a new locator
(mpl_toolkits.axes_grid.axes_divider.AxesLocator
) for
specified cell.
Parameters: | nx, nx1 : int
ny, ny1 : int
|
---|
set_anchor
(anchor)¶Parameters: | anchor : {‘C’, ‘SW’, ‘S’, ‘SE’, ‘E’, ‘NE’, ‘N’, ‘NW’, ‘W’}
|
---|
set_aspect
(aspect=False)¶Parameters: | aspect : bool |
---|
set_locator
(_locator)¶set_position
(pos)¶set the position of the rectangle.
Parameters: | pos : tuple of 4 floats
|
---|
mpl_toolkits.axes_grid.axes_divider.
AxesLocator
(axes_divider, nx, ny, nx1=None, ny1=None)¶A simple callable object, initialized with AxesDivider class, returns the position and size of the given cell.
Parameters: | axes_divider : AxesDivider nx, nx1 : int
ny, ny1 : int
|
---|
get_subplotspec
()¶mpl_toolkits.axes_grid.axes_divider.
SubplotDivider
(fig, *args, **kwargs)¶The Divider class whose rectangle area is specified as a subplot geometry.
Parameters: | fig : args : tuple (numRows, numCols, plotNum)
|
---|
change_geometry
(numrows, numcols, num)¶change subplot geometry, e.g., from 1,1,1 to 2,2,3
get_geometry
()¶get the subplot geometry, e.g., 2,2,3
get_position
()¶return the bounds of the subplot box
get_subplotspec
()¶get the SubplotSpec instance
set_subplotspec
(subplotspec)¶set the SubplotSpec instance
update_params
()¶update the subplot position from fig.subplotpars
mpl_toolkits.axes_grid.axes_divider.
AxesDivider
(axes, xref=None, yref=None)¶Divider based on the pre-existing axes.
Parameters: | axes : xref yref |
---|
append_axes
(position, size, pad=None, add_to_figure=True, **kwargs)¶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.
new_horizontal
(size, pad=None, pack_start=False, **kwargs)¶Add a new axes on the right (or left) side of the main axes.
Parameters: | size :
pad :
pack_start : bool
kwargs
|
---|
new_vertical
(size, pad=None, pack_start=False, **kwargs)¶Add a new axes on the top (or bottom) side of the main axes.
Parameters: | size :
pad :
pack_start : bool
kwargs
|
---|