mpl_toolkits.axes_grid1.colorbar¶

带两个类和一个函数的颜色条工具包：

ColorbarBase
具有完整颜色栏绘制功能的基类。它可以按原样为给定的颜色映射制作颜色条；不需要可映射对象（例如，图像）。

Colorbar
用于图像或轮廓图的派生类。

make_axes()
用于调整轴大小并添加适合颜色条的第二个轴的函数。

这个 colorbar() 方法使用 make_axes() 和 Colorbar ； colorbar() 函数是一个薄包装 colorbar() .

class mpl_toolkits.axes_grid1.colorbar.CbarAxesLocator(locator=None, extend='neither', orientation='vertical')[源代码]¶

cBaraxeSlocator是颜色条轴的轴定位器。它调整轴的位置，为延长端留出空间，即延长端位于轴区域之外。

定位器从定位器返回的bbox用作: 初始轴位置。如果没有，则使用axes.bbox。

延伸：与ColorBarbase中相同方向：与ColorBarbase中相同

get_end_vertices()[源代码]¶

返回colorbar扩展端的两个顶点的元组。

第一个顶点是最小端点，第二个顶点是最大端点。

get_original_position(axes, renderer)[源代码]¶: 返回轴的原始位置。

get_path_ends()[源代码]¶: 返回延伸端的路径。

get_path_patch()[源代码]¶: 返回轴面片的路径。

class mpl_toolkits.axes_grid1.colorbar.Colorbar(ax, mappable, **kw)[源代码]¶

参数:	norm ： `matplotlib.colors.Normalize` （或其子类）matplotlib.colors.Normalize（或其子类）标准化对象，用于将数据按一定比例缩放到间隔中 `[0, 1]` .如果 None ， norm 默认为 colors.Normalize 对象，该对象根据处理的第一个数据初始化其缩放。 cmap STR或 `Colormap`str或用于将规范化数据值映射到rgba颜色的颜色映射。

add_lines(CS)[源代码]¶: 添加非填充行 ContourSet 到颜色条。

update_bruteforce(mappable)[源代码]¶: 更新颜色栏艺术家以反映关联映射表的更改。

update_normal(mappable)[源代码]¶

更新实心面片、线条等。

这意味着当此色条所属的图像或等高线图的标准发生变化时调用。

如果可映射的规范与以前不同，这将重置轴的定位器和格式化程序，因此如果这些已被自定义，则需要再次自定义它们。但是，如果规范仅更改 vmin ， vmax 或 cmap 然后旧的格式化程序和定位器将被保留。

class mpl_toolkits.axes_grid1.colorbar.ColorbarBase(ax, cmap=None, norm=None, alpha=1.0, values=None, boundaries=None, orientation='vertical', extend='neither', spacing='uniform', ticks=None, format=None, drawedges=False, filled=True)[源代码]¶

在现有轴中绘制颜色条。

这是 Colorbar 类，它是 colorbar() 方法和Pyplot函数。

它本身也有助于显示颜色图。如果 cmap Kwarg被给予，但是边界和 价值观 保留为“无”，则颜色映射将以0-1的比例显示。要显示欠值和超值颜色，请指定 norm AS：：

colors.Normalize(clip=False)

要显示颜色与索引，而不是0-1比例，请使用：

norm=colors.NoNorm.

有用的属性：

ax
在其中绘制颜色条的轴实例

lines
如果绘制了线条，则为LineCollection，否则为无。

dividers
LineCollection如果 排水楔 是真的，否则没有

有用的公共方法是 set_label() 和 add_lines() .

参数:	norm ： `matplotlib.colors.Normalize` （或其子类）matplotlib.colors.Normalize（或其子类）标准化对象，用于将数据按一定比例缩放到间隔中 `[0, 1]` .如果 None ， norm 默认为 colors.Normalize 对象，该对象根据处理的第一个数据初始化其缩放。 cmap STR或 `Colormap`str或用于将规范化数据值映射到rgba颜色的颜色映射。

add_lines(levels, colors, linewidths)[源代码]¶: 在颜色栏上画线。它删除先前存在的行。

set_alpha(alpha)[源代码]¶: 设置透明度的alpha值。

set_label_text(label, **kw)[源代码]¶: 标记colorbar的长轴。

update_artists()[源代码]¶: 更新颜色栏关联的艺术家，填满和 ends . 注意线未更新。每当关联图像的clim发生更改时，都需要调用此函数。

mpl_toolkits.axes_grid1.colorbar.colorbar(mappable, cax=None, ax=None, **kw)[源代码]¶

为scalarmapable实例创建颜色栏。

Pyplot薄型包装的文档：

在绘图中添加颜色条。

的函数签名 pyplot 接口；除第一个外，所有都是 colorbar() 方法：

colorbar(**kwargs)
colorbar(mappable, **kwargs)
colorbar(mappable, cax=cax, **kwargs)
colorbar(mappable, ax=ax, **kwargs)

参数：

可映射的
这个 Image ， ContourSet 等；此参数对于 colorbar() 方法，但对于 colorbar() 函数，将默认值设置为当前图像。

关键字参数：

cax
无将绘制颜色条的轴对象

ax
无父轴对象，从中窃取新颜色条轴的空间

其他关键字参数有两种：

轴属性：

财产描述

方向垂直或水平

分数 0.15；用于颜色条的原始轴的分数

pad 垂直0.05，水平0.15；颜色条和新图像轴之间原始轴的分数

收缩 1.0；缩小颜色条的分数

方面 20；长尺寸与短尺寸之比

颜色条属性：

财产描述

延伸 ['neither''both''min''max'] 如果不是“两者都不是”，则为超出范围的值制作尖端。这些是为给定的颜色映射设置的，使用颜色映射设置和设置方法。

间距 [“均匀”“成比例”] 均匀间距使每个离散颜色具有相同的空间；比例间距使空间与数据间隔成比例。

蜱类 [无记号列表定位器对象] 如果没有，则自动根据输入确定刻度。

格式 [无格式化字符串格式化程序对象] 如果没有， ScalarFormatter 使用。如果给定格式字符串，例如 '%.3f' ，则使用该字符串。另一种选择 Formatter 可以改为给定对象。

排水楔 bool是否在颜色边界绘制线条。

以下内容可能只在索引颜色的上下文（即，当可映射表具有norm=nonorm（）时）或其他异常情况下有用。

财产描述

边界无或序列

价值观 无或序列的长度必须小于边界 . 对于由中相邻条目分隔的每个区域边界，将使用映射到值中相应值的颜色。

如果 可映射的 是一个 ContourSet 它的延伸 Kwarg自动包含在内。

请注意收缩 Kwarg提供了一种简单的方法来保持垂直颜色条，例如，使其不高于与颜色条相连的可映射的轴；但这是一种需要一些尝试和错误的手动方法。如果颜色条太高（或水平颜色条太宽），请使用较小的值收缩 .

要获得更精确的控制，可以手动指定轴对象的位置，其中绘制了可映射和颜色条。在这种情况下，不要使用任何轴属性Kwargs。

众所周知，一些矢量图形查看器（SVG和PDF）渲染颜色条段之间的空白。这是由于观众中的错误而不是Matplotlib。作为解决方案，颜色栏可以用重叠段呈现：

cbar = colorbar()
cbar.solids.set_edgecolor("face")
draw()

但在其他情况下，这会产生负面影响。尤其是对于半透明图像（alpha<1）和颜色条扩展，默认情况下不启用，请参阅（问题1188）。

返回：: Colorbar 实例；另请参见其基类， ColorbarBase . 打电话给 set_label() 方法标记颜色条。

的传感器 cax 调整，使最长轴中的限制实际上对应于颜色条范围中的限制。另一方面，最短轴的数据限制为 [1,2] ，其非常规值是在使用对数刻度时防止下溢。

mpl_toolkits.axes_grid1.colorbar.make_axes(parent, *, fraction=0.15, shrink=1.0, aspect=20, **kw)[源代码]¶

调整父轴的大小和位置，并返回适合颜色条的子轴

cax, kw = make_axes(parent, **kw)

关键字参数可以包括以下内容（使用默认值）：

方向
“垂直”或“水平”

财产	描述
方向	垂直或水平
分数	0.15；用于颜色条的原始轴的分数
pad	垂直0.05，水平0.15；颜色条和新图像轴之间原始轴的分数
收缩	1.0；缩小颜色条的分数
方面	20；长尺寸与短尺寸之比

除了第一个以外，其余的都从输入功率组中剥离。

返回（cax，kw）、子轴和缩减的kw字典。

财产	描述
延伸	['neither''both''min''max'] 如果不是“两者都不是”，则为超出范围的值制作尖端。这些是为给定的颜色映射设置的，使用颜色映射设置和设置方法。
间距	[“均匀”“成比例”] 均匀间距使每个离散颜色具有相同的空间；比例间距使空间与数据间隔成比例。
蜱类	[无记号列表定位器对象] 如果没有，则自动根据输入确定刻度。
格式	[无格式化字符串格式化程序对象] 如果没有， `ScalarFormatter` 使用。如果给定格式字符串，例如 '%.3f' ，则使用该字符串。另一种选择 `Formatter` 可以改为给定对象。
排水楔	bool是否在颜色边界绘制线条。

财产	描述
边界	无或序列
价值观	无或序列的长度必须小于边界 . 对于由中相邻条目分隔的每个区域边界，将使用映射到值中相应值的颜色。