matplotlib.pyplot.colorbar #
- matplotlib.pyplot。颜色条(可映射=无, cax =无, ax =无, ** kwargs)[来源] #
在绘图中添加颜色条。
- 参数:
- 可映射的
此颜色条描述的
matplotlib.cm.ScalarMappable
(即 、AxesImage
等ContourSet
)。此参数对于Figure.colorbar
方法是必需的,但对于函数是可选的pyplot.colorbar
,它将默认设置为当前图像。请注意,可以创建
ScalarMappable
“即时”来生成未附加到先前绘制的艺术家的颜色条,例如fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
- cax
Axes
, 可选的 将在其中绘制颜色条的轴。
- ax
Axes
,轴列表,可选 一个或多个父轴,如果cax为 None ,新颜色条轴的空间将被盗。如果设置了 cax ,这将无效。
- use_gridspec bool,可选
如果cax是
None
,则创建一个新的cax作为 Axes 的实例。如果ax是 Subplot 的实例并且use_gridspec是True
,则使用模块将cax创建为 Subplot 的实例 。gridspec
- 返回:
- 彩条
Colorbar
- 彩条
- 其他参数:
- 位置无或 {'left', 'right', 'top', 'bottom'}
创建颜色条轴的位置,相对于父轴。它还决定了颜色条的方向(左右颜色条是垂直的,顶部和底部的颜色条是水平的)。如果没有,如果设置了位置,则位置将来自 方向(右侧的垂直颜色条,底部的水平颜色条),如果未设置方向,则默认为“右”。
- 方向无或 {'vertical', 'horizontal'}
颜色条的方向。最好设置颜色条的位置 ,因为这也决定了方向;传递不兼容的位置和方向值会引发异常。
- 分数浮点数,默认值:0.15
用于颜色条的原始轴的分数。
- 收缩浮动,默认:1.0
与颜色条大小相乘的分数。
- 方面浮动,默认:20
长尺寸与短尺寸的比率。
- pad float,默认值:0.05如果垂直,0.15如果水平
颜色条和新图像轴之间的原始轴的分数。
- 锚(浮动,浮动),可选
颜色条轴的锚点。如果垂直,则默认为 (0.0, 0.5);(0.5, 1.0) 如果水平。
- panchor (float, float), 或False , 可选
颜色栏父轴的锚点。如果为False,则父坐标区的锚点将保持不变。如果垂直,则默认为 (1.0, 0.5);(0.5, 0.0) 如果水平。
- 扩展{'两者都','两者','min','max'}
为超出范围的值设置尖端(除非“两者都不”)。这些是使用颜色图 set_under 和 set_over 方法为给定颜色图设置的。
- extendfrac {无,'自动',长度,长度}
如果设置为None,最小和最大三角形颜色条扩展的长度都是内部颜色条长度的 5%(这是默认设置)。
如果设置为“自动”,则使三角形颜色条扩展的长度与内部框的长度相同(当间距设置为“统一”时)或与相应的相邻内部框的长度相同(当间距设置为“成比例”时)。
如果是标量,则将最小和最大三角形颜色条扩展的长度表示为内部颜色条长度的一部分。也可以给出分数的二元素序列,分别指示最小和最大颜色条扩展的长度作为内部颜色条长度的一部分。
- 扩展矩形布尔
如果False最小和最大颜色条扩展将是三角形的(默认)。如果为True,则扩展将是矩形的。
- 间距{'均匀','比例'}
对于离散的颜色条(
BoundaryNorm
或轮廓),'uniform' 为每种颜色提供相同的空间;'proportional' 使空间与数据间隔成比例。- 刻度无或刻度或定位器列表
如果为 None,则从输入中自动确定刻度。
- 格式None 或 str 或 Formatter
如果没有,
ScalarFormatter
则使用。支持格式字符串,例如,"%4.2e"
或"{x:.2e}"
,。Formatter
可以给出替代方案。- 拉边布尔
是否在颜色边界处画线。
- 标签str
颜色条长轴上的标签。
- 边界、值无或序列
如果未设置,颜色图将以 0-1 的比例显示。如果是序列,值的长度必须小于边界1 。对于由边界中的相邻条目分隔的每个区域,将使用映射到 values 中相应值的颜色。通常仅对索引颜色(即
norm=NoNorm()
)或其他异常情况有用。
笔记
如果mappable是 a
ContourSet
,它的extend kwarg 会自动包含在内。收缩kwarg 提供了一种相对于轴缩放颜色条的简单方法。请注意,如果指定了cax,它会确定颜色条的大小,并且会忽略收缩和方面的 kwargs。
要进行更精确的控制,您可以手动指定绘制可映射对象和颜色条的坐标区对象的位置。在这种情况下,不要使用任何轴属性 kwargs。
众所周知,一些矢量图形查看器(svg 和 pdf)会在颜色条段之间呈现白色间隙。这是由于查看器中的错误,而不是 Matplotlib。作为一种解决方法,可以使用重叠段渲染颜色栏:
cbar = colorbar() cbar.solids.set_edgecolor("face") draw()
然而,这在其他情况下会产生负面影响,例如半透明图像(alpha < 1)和颜色条扩展;因此,默认情况下不使用此解决方法(请参阅问题 #1188)。