mpl_toolkits.axes_grid1.axes_grid.Grid

class mpl_toolkits.axes_grid1.axes_grid. Grid ( fig, rect, nrows_ncols, ngrids=None, direction='row', axes_pad=0.02, *, share_all=False, share_x=True, share_y=True, label_mode='L', axes_class=None, aspect=False ) [source]

Bases: object

A grid of Axes.

In Matplotlib, the axes location (and size) is specified in normalized figure coordinates. This may not be ideal for images that needs to be displayed with a given aspect ratio; for example, it is difficult to display multiple images of a same size with some fixed padding between them. AxesGrid can be used in such case.

Parameters

fig Figure

The parent figure.

rect (float, float, float, float) or int

The axes position, as a (left, bottom, width, height) tuple or as a three-digit subplot position code (e.g., "121").

nrows_ncols (int, int)

Number of rows and columns in the grid.

ngrids int or None, default: None

If not None, only the first ngrids axes in the grid are created.

direction {"row", "column"}, default: "row"

Whether axes are created in row-major ("row by row") or column-major order ("column by column"). This also affects the order in which axes are accessed using indexing (grid[index]).

axes_pad float or (float, float), default: 0.02

Padding or (horizontal padding, vertical padding) between axes, in inches.

share_all bool, default: False

Whether all axes share their x- and y-axis. Overrides share_x and share_y.

share_x bool, default: True

Whether all axes of a column share their x-axis.

share_y bool, default: True

Whether all axes of a row share their y-axis.

label_mode {"L", "1", "all"}, default: "L"

Determines which axes will get tick labels:

• "L": All axes on the left column get vertical tick labels; all axes on the bottom row get horizontal tick labels.
• "1": Only the bottom left axes is labelled.
• "all": all axes are labelled.

axes_class subclass of matplotlib.axes.Axes, default: None

aspect bool, default: False

Whether the axes aspect ratio follows the aspect ratio of the data limits.

get_aspect ( ) [source]

Return the aspect of the SubplotDivider.

get_axes_locator ( ) [source]

get_axes_pad ( ) [source]

Return the axes padding.

Returns

hpad, vpad

Padding (horizontal pad, vertical pad) in inches.

get_divider ( ) [source]

get_geometry ( ) [source]

Return the number of rows and columns of the grid as (nrows, ncols).

get_vsize_hsize ( ) [source]

[Deprecated]

Notes

Deprecated since version 3.5:

set_aspect ( aspect ) [source]

Set the aspect of the SubplotDivider.

set_axes_locator ( locator ) [source]

set_axes_pad ( axes_pad ) [source]

Set the padding between the axes.

Parameters

axes_pad (float, float)

The padding (horizontal pad, vertical pad) in inches.

set_label_mode ( mode ) [source]

Define which axes have tick labels.

Parameters

mode {"L", "1", "all"}

The label mode:

• "L": All axes on the left column get vertical tick labels; all axes on the bottom row get horizontal tick labels.
• "1": Only the bottom left axes is labelled.
• "all": all axes are labelled.