matplotlib.pyplot.colorbar

matplotlib.pyplot.colorbar(mappable=None, cax=None, ax=None, **kw)[源代码]

在绘图中添加颜色条。

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

colorbar(**kwargs)
colorbar(mappable, **kwargs)
colorbar(mappable, cax=cax, **kwargs)
colorbar(mappable, ax=ax, **kwargs)
参数:
mappable

这个 matplotlib.cm.ScalarMappable （即， AxesImage ， ContourSet 等等）由这个颜色条描述。此参数对于 Figure.colorbar 方法，但对于 pyplot.colorbar 函数，将默认值设置为当前图像。

注意，可以创建一个 ScalarMappable “动态”生成未附加到先前绘制的艺术家的色条，例如：

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
cax ： Axes 可选可选轴

将要绘制颜色条的轴。

ax ： Axes ，轴列表，可选轴，轴列表，可选

将从中窃取新颜色条轴空间的父轴。如果给定了轴列表，则所有轴都将调整大小，以便为颜色条轴留出空间。

use_gridspec可选的布尔

如果 cax 是 None ，一个新的 cax 创建为轴的实例。如果 ax 是子批次的实例，并且 use_gridspec 是 True ， cax 使用 gridspec 模块。
返回:
彩条 ： Colorbar测控条

另请参见它的基类， ColorbarBase .

笔记

其他关键字参数有两种：

轴属性：

分数浮动，默认值：0.15
用于色条的原始轴的分数。
收缩浮动，默认值：1.0
要乘以色条大小的分数。
方面浮动，默认值：20
长短尺寸比。
衬垫浮动，默认值：垂直时为0.05，水平时为0.15
色条和新图像轴之间原始轴的分数。
锚（浮动，浮动）可选
颜色条轴的定位点。如果垂直，则默认为（0.0，0.5）；如果水平，则默认为（0.5，1.0）。
panchor：（float，float）或 假 可选（浮动，浮动），或
点颜色条的父颜色条。如果 假 ，父轴的定位将保持不变。如果垂直，则默认为（1.0，0.5）；如果水平，则默认为（0.5，0.0）。

颜色条属性：

财产 描述
延伸 {'never'、'both'、'min'、'max'}如果不是'never'，为超出范围的值指定一个或多个端点。这些是使用colormap set_under和set_over方法为给定colormap设置的。
扩展压裂 { None ，'auto'，length，length}如果设置为 None ，最小和最大三角形颜色条延长线的长度为内部颜色条长度的5%（这是默认设置）。如果设置为“自动”，则使三角形颜色条延长与内部框的长度相同（当 间距 设置为“统一”或与相应的相邻内箱相同的长度（当 间距 设置为“成比例”）。如果是标量，则指示作为内部颜色条长度的一部分的最小和最大三角形颜色条扩展的长度。还可以给出分数的两个元素序列，分别表示作为内部颜色条长度的分数的最小和最大颜色条扩展的长度。
扩展码 布尔若 假 最小和最大颜色条扩展将是三角形的（默认）。如果 True 延伸部分应为矩形。
间距 {'uniform'，'proportional'}均匀间距为每个离散颜色提供相同的空间；proportional使空间与数据间隔成比例。
蜱类 None 或记号或定位器列表如果没有，则从输入自动确定记号。
格式 None或str或Formatter如果没有， ScalarFormatter 使用。如果给定格式字符串，例如“%.3f”，则使用该字符串。另一种选择 Formatter 可能会被取代。
排水楔 bool是否在颜色边界绘制线条。
标签 在colorbar的长轴上设置标签。

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

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

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

这个 收缩 Kwarg提供了一种简单的方法来根据轴缩放颜色条。注意如果 cax ，它确定colorbar和 收缩 和 方面 夸克被忽略了。

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

众所周知，一些矢量图形查看器（svg和pdf）呈现colorbar段之间的空白。这是由于查看器中的错误，而不是Matplotlib。作为解决方法，可以使用重叠的线段渲染colorbar:：

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

然而，这在其他情况下会产生负面影响，例如半透明图像（alpha<1）和colorbar扩展；因此，默认情况下不使用此解决方案（见问题1188）。