matplotlib.colorbar

颜色条是从标量值到颜色映射的可视化。在Matplotlib中，它们被绘制成一个专用的 Axes .

注解

色条通常是通过 Figure.colorbar 或者它的pyplot包装器 pyplot.colorbar ，使用 make_axes 和 Colorbar 内部的。

作为最终用户，您很可能不必显式地调用该模块中的方法或实例化类。

ColorbarBase
基类具有完整的colorbar绘图功能。它可以按原样为给定的colormap创建颜色条；不需要可映射的对象（例如图像）。
Colorbar
在…之上 ColorbarBase 这将色条与 ScalarMappable 例如图像或等高线图。
ColorbarPatch
专门的 Colorbar 支持阴影等高线图。
make_axes()
创建一个 Axes 适用于色条。此功能可用于包含单个轴或自由放置轴的图形。
make_axes_gridspec()
创建一个 SubplotBase 适用于色条。此函数应用于将颜色条添加到 GridSpec .
class matplotlib.colorbar.Colorbar(ax, mappable, **kwargs)[源代码]

基类：matplotlib.colorbar.ColorbarBase

这个类连接 ColorbarBase 到A ScalarMappable 例如 AxesImage 生成通过 imshow .

注解

该类不打算直接实例化；而是使用 Figure.colorbar 或 pyplot.colorbar 创建颜色条。

add_lines(CS, erase=True)[源代码]

添加非填充行 ContourSet 到颜色条。

参数:
CS ： ContourSetContourSet

线条位置取自轮廓集级别。不得填充轮廓集。

erasebool，默认值：True

是否删除以前添加的任何行。
on_mappable_changed(mappable)[源代码]

[Deprecated] 更新此颜色栏以匹配可映射的属性。

通常，它会自动注册为事件处理程序 colorbar_factory() 不应手动调用。

笔记

3.3 版后已移除.

remove()[源代码]

从图中删除此色条。

如果颜色栏是用 use_gridspec=True 将恢复以前的gridspec。

update_bruteforce(mappable)[源代码]

[Deprecated] 销毁并重建颜色条。这将变得过时，可能会被弃用，然后删除。当使用pyplot.colorbar函数或figure.colorbar方法创建colorbar时，不调用该函数。

笔记

3.3 版后已移除.

update_normal(mappable)[源代码]

更新实心面片、线条等。

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

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

class matplotlib.colorbar.ColorbarBase(ax, *, cmap=None, norm=None, alpha=None, values=None, boundaries=None, orientation='vertical', ticklocation='auto', extend=None, spacing='uniform', ticks=None, format=None, drawedges=False, filled=True, extendfrac=None, extendrect=False, label='')[源代码]

基类：object

在现有轴中绘制颜色条。

只有少数情况下，您可以直接使用 ColorbarBase 作为最终用户。通常，颜色条与 ScalarMappable 例如 AxesImage 生成通过 imshow . 对于这些情况，您将使用 Colorbar 很可能通过 pyplot.colorbar 或 Figure.colorbar .

使用 ColorbarBase 当colorA中的元素不与图形中的其他元素相关联时。

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

norm=colors.Normalize(clip=False)

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

norm=colors.NoNorm()

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

参数:
ax ： Axes轴线

这个 Axes 在其中绘制颜色条的实例。

cmap : Colormap, default: rcParams["image.cmap"] (default: 'viridis')颜色映射，默认值：rcParams ["image.cmap"] （默认值：“viridis”）

要使用的颜色映射。

norm ： Normalize归一化
alpha浮动

颜色栏透明度介于0（透明）和1（不透明）之间。

values
boundaries
orientation{'垂直'，'水平'}
ticklocation{'auto'、'left'、'right'、'top'、'bottom'}
extend{'never'、'both'、'min'、'max'}
spacing{'uniform'，'proportional'}
蜱类 ： Locator 或者像浮子一样的数组定位器或类似float的数组
格式 STR或 Formatterstr或
drawedges布尔
filled布尔
extendfrac
extendrec
labelSTR
属性:
ax ： Axes轴线

这个 Axes 在其中绘制颜色条的实例。

lines列表

列表 LineCollection 如果画了线，则为空列表。

除法器 ： LineCollectionLineCollection

LineCollection如果 排水楔 是 True ，否则 None .
add_lines(levels, colors, linewidths, erase=True)[源代码]

在颜色栏上画线。

这些行将附加到列表中 lines .

参数:
levels类数组

线条的位置。

colors颜色或颜色列表

应用于所有行的单个颜色或每行的一个颜色值。

linewidths浮点数或类似数组的

应用于所有行的单个线宽或每行的一个线宽。

erasebool，默认值：True

是否删除以前添加的任何行。
config_axis()[源代码]

[Deprecated]

笔记

3.3 版后已移除:

draw_all()[源代码]

根据当前的CMAP和规范计算任意自由参数，并绘制所有图纸。

get_ticks(minor=False)[源代码]

返回x记号作为位置列表。

minorticks_off()[源代码]

关闭颜色栏的次要刻度。

minorticks_on()[源代码]

打开颜色条的小刻度，而不挤压到“延伸区域”。

n_rasterize = 50
remove()[源代码]

从图中删除此色条。

set_alpha(alpha)[源代码]

将透明度设置为介于0（透明）和1（不透明）之间。

set_label(label, *, loc=None, **kwargs)[源代码]

向颜色栏的长轴添加标签。

set_ticklabels(ticklabels, update_ticks=True)[源代码]

设置刻度标签。

勾号标签会立即更新，除非 update_ticks 是 假 ，在这种情况下，应该打电话 update_ticks 明确地。

set_ticks(ticks, update_ticks=True)[源代码]

设置刻度位置。

参数:
蜱类 ：类数组或 Locator 或无类数组或

刻度位置可以由值数组硬编码；也可以由 Locator . 设置为 None 恢复为使用默认定位器。

update_ticksbool，默认值：True

如果为True，则会立即更新记号位置。如果为False，则用户必须调用 update_ticks 稍后更新滴答声。
update_ticks()[源代码]

强制更新刻度和刻度标签。只要勾号定位器和/或勾号格式化程序更改，就必须调用此函数。

class matplotlib.colorbar.ColorbarPatch(ax, mappable, **kw)[源代码]

基类：matplotlib.colorbar.Colorbar

使用 Patch 实例而不是默认值 PatchCollection 创建的 pcolor ，因为后者不允许填充图案在集合的成员之间变化。

matplotlib.colorbar.colorbar_factory(cax, mappable, **kwargs)[源代码]

在给定的轴上为给定的可映射对象创建一个颜色条。

注解

这是一个低级函数，用于将现有轴转换为颜色条轴。通常，您需要使用 colorbar 相反，它也会自动处理适当轴的创建和放置。

参数:
cax ： Axes轴线

这个 Axes 变成色条。

可映射的 ： ScalarMappableScalarMappable

要由颜色栏描述的可映射性。

**kwargs

关键字参数被传递给相应的colorbar类。
返回:
Colorbar or ColorbarPatch

创建的colorbar实例。 ColorbarPatch 仅用于 可映射的 是一个 ContourSet 带舱口。
matplotlib.colorbar.make_axes(parents, location=None, orientation=None, fraction=0.15, shrink=1.0, aspect=20, **kw)[源代码]

创建一个 Axes 适用于色条。

轴放置在 父母 轴，通过调整大小和重新定位 父母 .

参数:
父母 ： Axes 或列表 Axes轴或轴列表

用作放置颜色条的父轴。

location无或{'left'、'right'、'top'、'bottom'}

位置，相对于 父母 ，创建颜色条轴的位置。如果没有，则该值将来自给定的 orientation ，否则将默认为“右”。

orientation无或{'垂直'，'水平'}

颜色条的方向。通常，不应使用此关键字，因为它可以从 location 关键字。

fraction浮动，默认值：0.15

用于色条的原始轴的分数。

shrink浮动，默认值：1.0

要乘以色条大小的分数。

aspect浮动，默认值：20

长短尺寸比。
返回:
cax ： Axes轴线

子轴。

kw双关语

创建colorbar实例时要传递的简化关键字字典。
其他参数:
pad浮动，默认值：垂直时为0.05，水平时为0.15

色条和新图像轴之间原始轴的分数。

anchor（浮动，浮动）可选

颜色条轴的定位点。如果垂直，则默认为（0.0，0.5）；如果水平，则默认为（0.5，1.0）。

潘乔 ：（浮动，浮动），或 假 可选（浮动，浮动），或

点颜色条的父颜色条。如果 假 ，父轴的定位将保持不变。如果垂直，则默认为（1.0，0.5）；如果水平，则默认为（0.5，0.0）。
matplotlib.colorbar.make_axes_gridspec(parent, *, fraction=0.15, shrink=1.0, aspect=20, **kw)[源代码]

创建一个 SubplotBase 适用于色条。

轴放置在 起源 轴，通过调整大小和重新定位 起源 .

此功能类似于 make_axes . 主要区别是

虽然此函数旨在与 make_axes 可能会有一些细微的差异。

参数:
起源 ： Axes轴线

要用作放置颜色条的父级的轴。

fraction浮动，默认值：0.15

用于色条的原始轴的分数。

shrink浮动，默认值：1.0

要乘以色条大小的分数。

aspect浮动，默认值：20

长短尺寸比。
返回:
cax ： SubplotBaseSubplotBase

子轴。

kw双关语

创建colorbar实例时要传递的简化关键字字典。
其他参数:
orientation{'vertical'，'horizontal'}，默认值：'vertical'

颜色条的方向。

pad浮动，默认值：垂直时为0.05，水平时为0.15

色条和新图像轴之间原始轴的分数。

anchor（浮动，浮动）可选

颜色条轴的定位点。如果垂直，则默认为（0.0，0.5）；如果水平，则默认为（0.5，1.0）。

潘乔 ：（浮动，浮动），或 假 可选（浮动，浮动），或

点颜色条的父颜色条。如果 假 ，父轴的定位将保持不变。如果垂直，则默认为（1.0，0.5）；如果水平，则默认为（0.5，0.0）。