Python matplotlib PathCollection.legend_elements用法及代码示例

本文简要介绍 python 语言中matplotlib.collections.PathCollection.legend_elements的用法。

用法

legend_elements(prop='colors', num='auto', fmt=None, func=<function PathCollection.<lambda>>, **kwargs)

为 PathCollection 创建图例句柄和标签。

每个图例句柄都是一个 Line2D ，代表所绘制的路径，每个标签都是一个字符串，每个路径代表什么。

这对于获取 scatter 图的图例很有用；例如：

scatter = plt.scatter([1, 2, 3],  [4, 5, 6],  c=[7, 2, 3])
plt.legend(*scatter.legend_elements())

创建三个图例元素，每种颜色一个，其数值作为标签传递给c。

另请参阅自动图例创建示例。

参数：

prop {"colors", "sizes"}，默认："colors"

如果"colors"，图例句柄将显示集合的不同颜色。如果"sizes"，图例将显示不同的大小。要同时设置两者，请使用kwargs 直接编辑 Line2D 属性。

num int、None、"auto"(默认)、类似数组或 Locator

要创建的目标元素数。如果没有，则使用可映射数组的所有唯一元素。如果是整数，则目标是使用规范范围内的num 元素。如果 "auto" ，尝试确定哪个选项更适合数据的性质。由于使用 Locator 来查找有用的位置，创建的元素数量可能与num 略有不同。如果是列表或数组，请使用这些元素作为图例。最后，可以提供 Locator 。

fmt str、 Formatter 或无(默认)

用于标签的格式或格式化程序。如果字符串必须是 StrMethodFormatter 的有效输入。如果 None (默认)，使用 ScalarFormatter 。

func 函数，默认：lambda x: x

计算标签的函数。通常， scatter 的大小(或颜色)参数将由用户使用函数s = f(x) 进行预处理以使标记可见；例如size = np.log10(x) 。在此处提供此函数的逆函数允许反转预处理，以便图例标签具有正确的值；例如func = lambda x: 10**x 。

**kwargs

允许的关键字参数是 color 和 size 。例如：如果使用prop="sizes"，设置标记的颜色可能很有用；如果使用prop="colors"，则类似于设置标记的大小。任何其他参数都将传递到 Line2D 实例。这可能对例如有用为图例句柄指定不同的 markeredgecolor 或 alpha。

返回：

handles Line2D 列表

图例中每个元素的可视化表示。

labels str 列表

图例元素的字符串标签。