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:
objectAn 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_locatormethod 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.
-
__dict__= mappingproxy({'__module__': 'mpl_toolkits.axes_grid1.axes_divider', '__doc__': '\n An Axes positioning class.\n\n The divider is initialized with lists of horizontal and vertical sizes\n (:mod:`mpl_toolkits.axes_grid1.axes_size`) based on which a given\n rectangular area will be divided.\n\n The `new_locator` method then creates a callable object\n that can be used as the *axes_locator* of the axes.\n ', '__init__': <function Divider.__init__>, 'get_horizontal_sizes': <function Divider.get_horizontal_sizes>, 'get_vertical_sizes': <function Divider.get_vertical_sizes>, 'get_vsize_hsize': <function Divider.get_vsize_hsize>, '_calc_k': <staticmethod object>, '_calc_offsets': <staticmethod object>, 'set_position': <function Divider.set_position>, 'get_position': <function Divider.get_position>, 'set_anchor': <function Divider.set_anchor>, 'get_anchor': <function Divider.get_anchor>, 'set_horizontal': <function Divider.set_horizontal>, 'get_horizontal': <function Divider.get_horizontal>, 'set_vertical': <function Divider.set_vertical>, 'get_vertical': <function Divider.get_vertical>, 'set_aspect': <function Divider.set_aspect>, 'get_aspect': <function Divider.get_aspect>, 'set_locator': <function Divider.set_locator>, 'get_locator': <function Divider.get_locator>, 'get_position_runtime': <function Divider.get_position_runtime>, 'locate': <function Divider.locate>, 'new_locator': <function Divider.new_locator>, 'append_size': <function Divider.append_size>, 'add_auto_adjustable_area': <function Divider.add_auto_adjustable_area>, '__dict__': <attribute '__dict__' of 'Divider' objects>, '__weakref__': <attribute '__weakref__' of 'Divider' objects>, '__annotations__': {}})¶
-
__init__(fig, pos, horizontal, vertical, aspect=None, anchor='C')[source]¶ 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.
-
__module__= 'mpl_toolkits.axes_grid1.axes_divider'¶
-
__weakref__¶ list of weak references to the object (if defined)
-
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
AxesLocatorfor 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{'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