mpl_toolkits.axes_grid1.axes_grid.ImageGrid#
- class mpl_toolkits.axes_grid1.axes_grid.ImageGrid(fig, rect, nrows_ncols, ngrids=None, direction='row', axes_pad=0.02, *, share_all=False, aspect=True, label_mode='L', cbar_mode=None, cbar_location='right', cbar_pad=None, cbar_size='5%', cbar_set_cax=True, axes_class=None)[源]#
基类:
Grid
用于图像显示的坐标轴网格。
这个类是
Grid
的一个特化,用于显示图像网格。特别是,它强制一列中的所有坐标轴共享它们的 x 轴,并且一行中的所有坐标轴共享它们的 y 轴。它还提供了辅助函数,用于向部分或所有坐标轴添加颜色条。- 参数:
- fig
Figure
父图。
- rect(浮点数, 浮点数, 浮点数, 浮点数) 或 整数
坐标轴位置,作为
(left, bottom, width, height)
元组或三位数字的子图位置代码(例如,“121”)。- nrows_ncols(整数, 整数)
网格中的行数和列数。
- ngrids整数或None, 默认值:None
如果不是 None,则只创建网格中的前 ngrids 个坐标轴。
- direction{"行", "列"}, 默认值: "row"
坐标轴是按行主序(“逐行”)还是按列主序(“逐列”)创建。这也影响了使用索引 (
grid[index]
) 访问坐标轴的顺序。- axes_pad浮点数 或 (浮点数, 浮点数), 默认值: 0.02英寸
坐标轴之间的填充或(水平填充,垂直填充),单位为英寸。
- share_all布尔值, 默认值: False
所有坐标轴是否共享它们的 x 轴和 y 轴。请注意,在任何情况下,一列中的所有坐标轴都会共享它们的 x 轴,一行中的所有坐标轴都会共享它们的 y 轴。
- aspect布尔值, 默认值: True
坐标轴的纵横比是否遵循数据限制的纵横比。
- label_mode{"L", "1", "all"}, 默认值: "L"
确定哪些坐标轴将获得刻度标签
“L”:左侧列上的所有坐标轴都获得垂直刻度标签;底部行上的所有坐标轴都获得水平刻度标签。
“1”:只有左下角的坐标轴被标记。
“all”:所有坐标轴都被标记。
- cbar_mode{"每个", "单个", "边缘", None}, 默认值: None
是为“每个”坐标轴创建一个颜色条,为整个网格创建一个“单个”颜色条,只为由 cbar_location 确定的“边缘”上的坐标轴创建颜色条,还是不创建颜色条。颜色条存储在
cbar_axes
属性中。- cbar_location{"左", "右", "下", "上"}, 默认值: "right"
- cbar_pad浮点数, 默认值: None
图像坐标轴和颜色条坐标轴之间的填充。
3.10 版本中的变化:
cbar_mode="single"
如果 cbar_location 是“left”或“bottom”,则不再在坐标轴和颜色条之间添加 axes_pad。- cbar_size尺寸规范(参见
Size.from_any
), 默认值: "5%" 颜色条尺寸。
- cbar_set_cax布尔值, 默认值: True
如果为 True,则网格中的每个坐标轴都具有一个绑定到相关联的 cbar_axes 的 cax 属性。
- axes_class
matplotlib.axes.Axes
的子类, 默认值: None
- fig