Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 5a2e809

Browse filesBrowse files
committed
DOC: Document axes_grid1.Grid attributes
1 parent 47c96df commit 5a2e809
Copy full SHA for 5a2e809

File tree

Expand file treeCollapse file tree

1 file changed

+22
-1
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+22
-1
lines changed

‎lib/mpl_toolkits/axes_grid1/axes_grid.py

Copy file name to clipboardExpand all lines: lib/mpl_toolkits/axes_grid1/axes_grid.py
+22-1Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,26 @@ class Grid:
3838
displayed with a given aspect ratio; for example, it is difficult to
3939
display multiple images of a same size with some fixed padding between
4040
them. AxesGrid can be used in such case.
41+
42+
Attributes
43+
----------
44+
axes_all : list of Axes
45+
A flat list of Axes. Note that you can also access this directly
46+
from the grid. The following is equivalent ::
47+
48+
grid[i] == grid.axes_all[i]
49+
len(grid) == len(grid.axes_all)
50+
51+
axes_column : list of list of Axes
52+
A 2D list of Axes where the first index is the column. This results
53+
in the usage pattern ``grid.axes_column[col][row]``.
54+
axes_row : list of list of Axes
55+
A 2D list of Axes where the first index is the row. This results
56+
in the usage pattern ``grid.axes_row[row][col]``.
57+
axes_llc : Axes
58+
The Axes in the lower left corner.
59+
ngrids : int
60+
Number of Axes in the grid.
4161
"""
4262

4363
_defaultAxesClass = Axes
@@ -93,7 +113,8 @@ def __init__(self, fig,
93113
- "all": All axes are labelled.
94114
- "keep": Do not do anything.
95115
96-
axes_class : subclass of `matplotlib.axes.Axes`, default: None
116+
axes_class : subclass of `matplotlib.axes.Axes`, default: `.mpl_axes.Axes`
117+
The type of Axes to create.
97118
aspect : bool, default: False
98119
Whether the axes aspect ratio follows the aspect ratio of the data
99120
limits.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.