Skip to content

Commit

Permalink
DOC: Document axes_grid1.Grid attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
timhoffm committed Mar 22, 2024
1 parent b1857a1 commit 1e9d816
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion lib/mpl_toolkits/axes_grid1/axes_grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,26 @@ class Grid:
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.
Attributes
----------
axes_all : list of Axes
A flat list of Axes. Note that you can also access this directly
from the grid. The following is equivalent ::
grid[i] == grid.axes_all[i]
len(grid) == len(grid.axes_all)
axes_column : list of list of Axes
A 2D list of Axes where the first index is the column. This results
in the usage pattern ``grid.axes_column[col][row]``.
axes_row : list of list of Axes
A 2D list of Axes where the first index is the row. This results
in the usage pattern ``grid.axes_column[row][col]``.
axes_llc : Axes
The Axes in the lower left corner.
ngrids : int
Number of Axes in the grid.
"""

_defaultAxesClass = Axes
Expand Down Expand Up @@ -93,7 +113,8 @@ def __init__(self, fig,
- "all": All axes are labelled.
- "keep": Do not do anything.
axes_class : subclass of `matplotlib.axes.Axes`, default: None
axes_class : subclass of `matplotlib.axes.Axes`, default: `.mpl_axes.Axes`
The type of Axes to create.
aspect : bool, default: False
Whether the axes aspect ratio follows the aspect ratio of the data
limits.
Expand Down

0 comments on commit 1e9d816

Please sign in to comment.