Version 3.1.1
Matplotlib is hiring a Research Software Engineering Fellow! See discourse for details. Apply by January 3, 2020
matplotlib.legend¶“图例”模块定义图例类，该类负责绘制与轴和/或图形关联的图例。
重要
您不太可能手动创建图例实例。大多数用户通常会通过 legend() 功能。更多关于传说的细节还有 legend guide .
Legend类可以视为包含Legend句柄和Legend文本的容器。从轴或图形中的绘图元素（例如线条、补丁等）创建相应的图例句柄由处理程序映射指定，该映射定义绘图元素和要使用的图例处理程序之间的映射（默认的图例处理程序在 legend_handler 模块）。注意，在默认情况下，并不是所有类型的艺术家都受图例支持，但是可以扩展图例处理程序的功能来支持任意对象。见 legend guide 更多信息。
matplotlib.legend.DraggableLegend(legend, use_blit=False, update='loc')[源代码]¶基类：matplotlib.offsetbox.DraggableOffsetBox
包装 Legend 支持鼠标拖动。
| 参数: |
|
|---|
matplotlib.legend.Legend(parent, handles, labels, loc=None, numpoints=None, markerscale=None, markerfirst=True, scatterpoints=None, scatteryoffsets=None, prop=None, fontsize=None, borderpad=None, labelspacing=None, handlelength=None, handleheight=None, handletextpad=None, borderaxespad=None, columnspacing=None, ncol=1, mode=None, fancybox=None, shadow=None, title=None, title_fontsize=None, framealpha=None, edgecolor=None, facecolor=None, bbox_to_anchor=None, bbox_transform=None, frameon=None, handler_map=None)[源代码]¶在位置loc的轴上放置图例。
| 参数: | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 其他参数: |
|
笔记
用户可以使用 bbox_to_anchor 关键字参数。bbox-to-u锚定可以是bboxbase（或其衍生物）的实例，也可以是2或4个浮点的元组。见 set_bbox_to_anchor() 更多细节。
可以通过设置指定图例位置 loc 有一个2个浮点数的元组，它被解释为标准化轴坐标中图例的左下角。
codes = {'best': 0, 'center': 10, 'center left': 6, 'center right': 7, 'lower center': 8, 'lower left': 3, 'lower right': 4, 'right': 5, 'upper center': 9, 'upper left': 2, 'upper right': 1}¶draggable(state=None, use_blit=False, update='loc')[源代码]¶设置可拖动状态——如果状态为
- 无：切换当前状态
- 正确：打开可拖动
- 错误：关闭可拖动
如果启用了Draggable，则可以使用鼠标在画布上拖动图例。这个 DraggableLegend 如果启用draggable，则返回helper实例。
更新参数控制拖动时图例的哪个参数发生更改。如果更新为“loc”，则 loc 图例的参数已更改。如果“BBOX”， bbox_to_anchor 参数已更改。
get_legend_handler(legend_handler_map, orig_handle)[源代码]¶从返回图例处理程序 legend_handler_map 相当于 orig_handler .
legend_handler_map 应该是字典对象（由get_legend_handler_map方法返回）。
它首先检查 orig_handle 它本身就是 legend_hanler_map 并返回关联值。否则，它按方法解析顺序检查每个类。如果找不到匹配的密钥，则返回 None .
get_tightbbox(renderer)[源代码]¶喜欢 Legend.get_window_extent ，但使用方框作为图例。
| 参数: |
|
|---|---|
| 返回: |
|
set_bbox_to_anchor(bbox, transform=None)[源代码]¶设置要锚定图例的bbox。
bbox 可以是
BboxBase 实例(left, bottom, width, height) 在给定的转换中（如果没有标准化轴坐标）(left, bottom) 其中宽度和高度假定为零。set_draggable(state, use_blit=False, update='loc')[源代码]¶启用或禁用对图例的鼠标拖动支持。
| 参数: |
|
|---|---|
| 返回: |
|
zorder = 5¶matplotlib.legend_handler¶此模块定义默认的图例处理程序。
强烈建议您阅读 legend guide 在此文档之前。
图例处理程序应为具有以下签名的可调用对象。：：
legend_handler(legend, orig_handle, fontsize, handlebox)
传奇 是传说本身， orig_handle 是原图， 字体大小 是以像素为单位的字体大小，以及 手提箱 是OffsetBox实例。在调用中，您应该创建相关的艺术家（使用 传奇 和/或 orig_handle ）把它们放进手提箱里。艺术家需要根据字体大小进行缩放（请注意，大小以像素为单位，即这是dpi缩放值）。
此模块包括使用以下方法从基类（handlerBase）派生的几个图例处理程序类的定义：
def legend_artist(self, legend, orig_handle, fontsize, handlebox)
matplotlib.legend_handler.HandlerBase(xpad=0.0, ypad=0.0, update_func=None)[源代码]¶默认图例处理程序的基类。
派生类旨在重写 create_artists 方法，该方法具有以下签名。：：
def create_artists(self, legend, orig_handle,
xdescent, ydescent, width, height, fontsize,
trans):
重写的方法需要创建符合给定维度（xdecent、ydescent、width、height）的给定转换的艺术家，如有必要，将按fontsize进行缩放。
legend_artist(legend, orig_handle, fontsize, handlebox)[源代码]¶返回此handlerBase为给定的原始艺术家/句柄生成的艺术家。
| 参数: |
|
|---|
matplotlib.legend_handler.HandlerCircleCollection(yoffsets=None, sizes=None, **kw)[源代码]¶汉德勒 CircleCollections .
matplotlib.legend_handler.HandlerErrorbar(xerr_size=0.5, yerr_size=None, marker_pad=0.3, numpoints=None, **kw)[源代码]¶误差线处理程序。
matplotlib.legend_handler.HandlerLine2D(marker_pad=0.3, numpoints=None, **kw)[源代码]¶汉德勒 Line2D 实例。
| 参数: |
|
|---|
笔记
任何其他关键字参数都提供给 HandlerNpoints .
matplotlib.legend_handler.HandlerLineCollection(marker_pad=0.3, numpoints=None, **kw)[源代码]¶汉德勒 LineCollection 实例。
| 参数: |
|
|---|