matplotlib.collections

用于高效绘制大量共享大部分属性的对象的类，例如大量线段或多边形。

这些类并不意味着像它们的单元素对应物那样灵活（例如，您可能无法选择所有线条样式），但它们旨在为常见用例提供快速解决方案（例如，大量实线线段）。

class matplotlib.collections.AsteriskPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)

基类：RegularPolyCollection

绘制一组具有 numsides 个点的规则星号。

参数:

numsides整数

多边形的边数。

旋转float

多边形旋转的弧度。

尺寸浮点数元组

圆的外接多边形的面积，单位为点^2。

**kwargs

转发至 Collection。

示例

参见 Lasso 演示 以获取完整示例:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    offset_transform=ax.transData,
    )

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_numsides()

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_rotation()

get_sizes()

返回集合中元素的大小（'面积'）。

返回:

数组

每个元素的 '区域'。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sizes	numpy.ndarray 或 None
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(paths)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sizes(sizes, dpi=72.0)

设置集合中每个成员的大小。

参数:

sizes : numpy.ndarray 或 Nonenumpy.ndarray 或 None

集合中每个元素要设置的大小。该值是元素的'面积'。

dpifloat, 默认值: 72

画布的dpi。

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.CircleCollection(sizes, **kwargs)

基类：_CollectionWithSizes

一组使用样条曲线绘制的圆。

参数:

尺寸浮点数或类似数组的对象

每个圆的面积，单位为点^2。

**kwargs

转发至 Collection。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_sizes()

返回集合中元素的大小（'面积'）。

返回:

数组

每个元素的 '区域'。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sizes	numpy.ndarray 或 None
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(paths)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sizes(sizes, dpi=72.0)

设置集合中每个成员的大小。

参数:

sizes : numpy.ndarray 或 Nonenumpy.ndarray 或 None

集合中每个元素要设置的大小。该值是元素的'面积'。

dpifloat, 默认值: 72

画布的dpi。

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.Collection(*, edgecolors=None, facecolors=None, linewidths=None, linestyles='solid', capstyle=None, joinstyle=None, antialiaseds=None, offsets=None, offset_transform=None, norm=None, cmap=None, pickradius=5.0, hatch=None, urls=None, zorder=1, **kwargs)

基类：Artist, ScalarMappable

集合的基类。必须被继承才能使用。

一个集合表示一系列可以更高效地一起绘制的 Patch 。例如，当一个路径在不同偏移量下重复绘制时，渲染器通常可以比一系列重复调用 draw_path() 并将偏移量逐一放入更高效地执行 draw_marker() 调用。

集合的大多数属性可以按元素进行配置。因此，集合有许多 Patch 属性的“复数”版本（例如 Collection.get_paths 而不是 Patch.get_path）。例外的是 zorder、hatch、pickradius、capstyle 和 joinstyle 属性，这些属性只能为整个集合全局设置。

除了这些例外，所有属性都可以指定为单个值（适用于所有元素）或值序列。集合中第 i 个元素的属性为:

prop[i % len(prop)]

每个集合可以选择性地通过将其 norm 和 cmap 参数传递给其构造函数，作为自己的 ScalarMappable 使用。如果集合的 ScalarMappable 矩阵 _A 已被设置（通过调用 Collection.set_array），那么在绘制时将使用这个内部标量映射来设置 facecolors 和 edgecolors，忽略那些手动传入的颜色。

参数:

edgecolors : color 或颜色列表，默认值: rcParams["patch.edgecolor"] (default: 'black')颜色或颜色列表，默认值：rcParams["patch.edgecolor"]（默认值：'black'）

构成集合的每个补丁的边缘颜色。可以传递特殊值 'face' 以使边缘颜色与面颜色匹配。

facecolors : color 或颜色列表, 默认值: rcParams["patch.facecolor"] (default: 'C0')颜色或颜色列表，默认值: rcParams["patch.facecolor"] (默认: 'C0')

构成集合的每个补丁的面颜色。

linewidths : float 或 float 列表, 默认值: rcParams["patch.linewidth"] (default: 1.0)浮点数或浮点数列表，默认值：

构成集合的每个补丁的行宽。

线型str 或 tuple 或其列表，默认值：'solid'

有效的字符串是 ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']。虚线元组应为以下形式:

(offset, onoffseq),

其中 onoffseq 是一个偶数长度的元组，包含点和点之间的墨水长度。有关示例，请参见 线条样式。

capstyle : 类似 CapStyle 的类型, 默认值: rcParams["patch.capstyle"]CapStyle-like, 默认值: rcParams["patch.capstyle"]

用于集合中所有路径的线帽样式。允许的值有 {'butt', 'projecting', 'round'}。

joinstyle : 类似 JoinStyle 的, 默认值: rcParams["patch.joinstyle"]JoinStyle-like, 默认值: rcParams["patch.joinstyle"]

用于连接集合中所有路径的线条样式的样式。允许的值为 {'miter', 'round', 'bevel'}。

antialiaseds : bool 或 bool 列表, 默认值: rcParams["patch.antialiased"] (default: True)布尔值或布尔值列表，默认值：

集合中的每个补丁是否应使用抗锯齿绘制。

偏移量(float, float) 或其列表，默认值：(0, 0)

在渲染后用于平移每个补丁的向量（默认不进行平移）。平移操作在屏幕（像素）坐标系中进行（即在应用了艺术家的变换之后）。

offset_transform : Transform, 默认: IdentityTransform变换，默认：IdentityTransform

在每个 offsets 向量被使用之前，将应用的单一变换。

cmap, norm

数据归一化和颜色映射参数。详细描述请参见 ScalarMappable。

hatchstr, 可选

填充路径中使用的填充图案（如果有）。有效的字符串包括 ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']。有关每种填充类型的含义，请参阅 Hatch 样式参考。

pickradiusfloat, 默认值: 5.0

如果 pickradius <= 0，那么当测试点位于集合中路径的控制点形成的多边形内部时，Collection.contains 将返回 True。另一方面，如果它大于 0，那么我们将检查测试点是否包含在集合中任意路径的宽度为 2*pickradius 的笔画内。

网址list of str, 默认: None

每个补丁在绘制后链接到的URL。目前仅适用于SVG后端。有关示例，请参见 超链接。

zorderfloat, 默认值: 1

绘图顺序，由集合中的所有补丁共享。查看 Zorder 演示 以获取所有默认值和示例。

**kwargs

剩余的关键字参数将用于为 kwargs 中的每个键值对设置属性，如 Collection.set_{key}(val)。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor	color 或 color 列表 或 'face'
facecolor	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle	str 或 tuple 或其列表
linewidth	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(paths)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.EllipseCollection(widths, heights, angles, *, units='points', **kwargs)

基类：Collection

一组使用样条曲线绘制的椭圆。

参数:

宽度类似数组

第一个轴的长度（例如，主轴长度）。

高度类似数组

第二轴的长度。

角度类似数组

第一轴的角度，从x轴逆时针方向的角度。

单位{'points', 'inches', 'dots', 'width', 'height', 'x', 'y', 'xy'}

主次刻度所用的单位；'width' 和 'height' 指的是轴的尺寸，而 'x' 和 'y' 指的是 偏移 数据单位。'xy' 与其他所有不同之处在于，绘制的角度随纵横比变化，只有在纵横比为1时才等于指定的角度。因此，它的行为与 Ellipse 在 axes.transData 作为其变换时相同。

**kwargs

转发至 Collection。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_angles()

获取第一个轴的角度，以逆时针方向从x轴开始的角度。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_heights()

设置第二轴的长度（例如，次轴）。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_widths()

获取第一个轴的长度（例如，主轴）。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, angles=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, heights=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, widths=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
角度	未知
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
高度	未知
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
宽度	未知
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_angles(angles)

设置第一个轴的角度，以逆时针方向从x轴开始的角度（度数）。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_heights(heights)

设置第二轴的长度（例如，次轴）。

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(paths)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_widths(widths)

设置第一个轴的长度（例如，主轴）。

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.EventCollection(positions, orientation='horizontal', *, lineoffset=0, linelength=1, linewidth=None, color=None, linestyle='solid', antialiased=None, **kwargs)

基类：LineCollection

沿着单个轴线的一系列位置，在这些位置上发生了“事件”。

事件由一个一维数组给出。它们没有振幅，并以平行线的形式显示。

参数:

职位1D 类数组

每个值都是一个事件。

方向{'horizontal', 'vertical'}, 默认: 'horizontal'

事件的顺序沿着这个方向绘制。单个事件的标记线沿着正交方向。

lineoffsetfloat, 默认值: 0

标记中心相对于原点的偏移量，方向与 orientation 垂直。

linelengthfloat, 默认值: 1

标记的总高度（即标记从 lineoffset - linelength/2 延伸到 lineoffset + linelength/2）。

linewidth : float 或其列表，默认值: rcParams["lines.linewidth"] (default: 1.5)浮点数或其列表，默认值：

事件线条的线宽，以点为单位。

颜色 : color 或 color 列表, 默认值: rcParams["lines.color"] (default: 'C0')颜色或颜色列表，默认值: rcParams["lines.color"] (默认: 'C0')

事件线的颜色。

linestylestr 或 tuple 或其列表，默认值：'solid'

有效的字符串是 ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']。虚线元组应为以下形式:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

antialiased : bool 或其列表, 默认值: rcParams["lines.antialiased"] (default: True)布尔值或其列表，默认值：

是否对绘制线条使用抗锯齿。

**kwargs

转发到 LineCollection。

示例

(Source code, 2x.png, png)

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

add_positions(position)

在指定位置添加一个或多个事件。

append_positions(position)

在指定位置添加一个或多个事件。

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

extend_positions(position)

在指定位置添加一个或多个事件。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_color()

返回用于标记每个事件的线条的颜色。

get_colors()

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gapcolor()

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linelength()

返回用于标记每个事件的线条长度。

get_lineoffset()

返回用于标记每个事件的行的偏移量。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

获取用于标记每个事件的线条的宽度。

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_orientation()

返回事件线的方向（'horizontal' 或 'vertical'）。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_positions()

返回一个包含位置浮点数值的数组。

get_rasterized()

返回艺术家是否将被光栅化。

get_segments()

返回:

列表

LineCollection 中的线段列表。每个列表项包含一个顶点数组。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_horizontal()

如果 eventcollection 是水平的则为 True，如果是垂直的则为 False。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, colors=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gapcolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linelength=<UNSET>, lineoffset=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, orientation=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, positions=<UNSET>, rasterized=<UNSET>, segments=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 color 列表
颜色	color 或 color 列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gapcolor	color 或 color 列表 或 None
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linelength	未知
lineoffset	未知
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
方向	{'horizontal', 'vertical'}
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
位置	未知
光栅化	布尔
segments	未知
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
verts	未知
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置 LineCollection 的边缘颜色。

参数:

c : color 或 color 列表颜色或颜色列表

单一颜色（所有线条颜色相同），或是一系列RGBA元组；如果是序列，线条将循环通过该序列。

set_colors(c)

设置 LineCollection 的边缘颜色。

参数:

c : color 或 color 列表颜色或颜色列表

单一颜色（所有线条颜色相同），或是一系列RGBA元组；如果是序列，线条将循环通过该序列。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gapcolor(gapcolor)

设置一个颜色来填充虚线样式中的间隙。

备注

条纹线是通过绘制两条交错的虚线创建的。这两条线之间可能会有重叠，在使用透明度时可能会导致伪影。

此功能是实验性的，可能会发生变化。

参数:

gapcolor : color 或 color 列表 或 None颜色或颜色列表或无

用于填充间隙的颜色。如果为 None，则间隙不填充。

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linelength(linelength)

设置用于标记每个事件的线条长度。

set_lineoffset(lineoffset)

设置用于标记每个事件的线条的偏移量。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_orientation(orientation)

设置事件线的方向。

参数:

方向{'horizontal', 'vertical'}

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(segments)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_positions(positions)

设置事件的位置。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_segments(segments)

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_verts(segments)

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

switch_orientation()

切换事件线的方向，可以从垂直变为水平，反之亦然。

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.LineCollection(segments, *, zorder=2, **kwargs)

基类：Collection

表示一组应一起绘制的 Line2D 序列。

这个类扩展了 Collection ，以表示一个 Line2D 序列，而不仅仅是一个 Patch 序列。与 Collection 中一样，LineCollection 的每个属性可以是单个值，也可以是值的列表。然后，这个列表会循环用于 LineCollection 的每个元素，因此集合的第 i 个元素的属性为:

prop[i % len(prop)]

每个 LineCollection 成员的属性默认为其在 rcParams["lines.*"] 中的值，而不是 rcParams["patch.*"] 中的值，并且属性 colors 被添加以替代 edgecolors。

参数:

片段类似数组的列表

一个序列（line0，line1，line2）的行，其中每一行是一个点的列表:

lineN = [(x0, y0), (x1, y1), ... (xm, ym)]

或等效的具有两列的 Mx2 numpy 数组。每行可以有不同数量的段。

linewidths : float 或 float 列表, 默认值: rcParams["lines.linewidth"] (default: 1.5)float 或 float 列表, 默认:

每行的宽度，单位为点。

颜色 : color 或颜色列表，默认值: rcParams["lines.color"] (default: 'C0')颜色或颜色列表，默认值: rcParams["lines.color"] (默认: 'C0')

一系列的 RGBA 元组（例如，不允许使用任意颜色字符串等）。

antialiaseds : bool 或 bool 列表, 默认值: rcParams["lines.antialiased"] (default: True)布尔值或布尔值列表，默认值：

是否为每条线使用抗锯齿。

zorderfloat, 默认值: 2

一旦绘制，线条的zorder。

facecolors : color 或 color 列表, 默认: 'none'颜色或颜色列表，默认值：'none'

当设置 facecolors 时，每条线都被解释为一个区域的边界，隐式地从最后一个点到第一个点闭合路径。封闭的区域用 facecolor 填充。为了手动指定每条线的“内部”，请使用 PathCollection，其中“内部”可以通过适当使用 CLOSEPOLY 来指定。

**kwargs

转发至 Collection。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_color()

get_colors()

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gapcolor()

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_segments()

返回:

列表

LineCollection 中的线段列表。每个列表项包含一个顶点数组。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, colors=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gapcolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, segments=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	未知
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 color 列表
颜色	color 或 color 列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gapcolor	color 或 color 列表 或 None
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
segments	未知
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
verts	未知
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置 LineCollection 的边缘颜色。

参数:

c : color 或 color 列表颜色或颜色列表

单一颜色（所有线条颜色相同），或是一系列RGBA元组；如果是序列，线条将循环通过该序列。

set_colors(c)

设置 LineCollection 的边缘颜色。

参数:

c : color 或 color 列表颜色或颜色列表

单一颜色（所有线条颜色相同），或是一系列RGBA元组；如果是序列，线条将循环通过该序列。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gapcolor(gapcolor)

设置一个颜色来填充虚线样式中的间隙。

备注

条纹线是通过绘制两条交错的虚线创建的。这两条线之间可能会有重叠，在使用透明度时可能会导致伪影。

此功能是实验性的，可能会发生变化。

参数:

gapcolor : color 或 color 列表 或 None颜色或颜色列表或无

用于填充间隙的颜色。如果为 None，则间隙不填充。

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(segments)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_segments(segments)

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_verts(segments)

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.PatchCollection(patches, *, match_original=False, **kwargs)

基类：Collection

一个通用的补丁集合。

PatchCollection 比大量等效的单个 Patch 绘制得更快。它还使得为异构的 Patch 集合分配颜色映射更加容易。

参数:

补丁 : Patch 的列表列表

一系列的 Patch 对象。这个列表可能包含不同类型的补丁的异构组合。

匹配原始bool, 默认值: False

如果为 True，则使用原始补丁的颜色和线宽。如果为 False，则可以通过提供标准的集合参数（如 facecolor、edgecolor、linewidths、norm 或 cmap）来分配新颜色。

**kwargs

所有其他参数都会传递给 Collection。

如果 edgecolors、facecolors、linewidths、antialiaseds 中的任何一个为 None，它们将默认使用 rcParams 中的 patch 设置，以序列形式。

注释

使用 ScalarMappable 功能是可选的。如果 ScalarMappable 矩阵 _A 已被设置（通过调用 set_array），在绘制时将调用标量映射来设置面颜色。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(patches)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.PathCollection(paths, sizes=None, **kwargs)

基类：_CollectionWithSizes

一组 Path，例如由 scatter 创建。

参数:

路径 : path.Path 的列表列表

构成 Collection 的路径。

尺寸类似数组

每个绘制的 Path 的缩放因子。在路径的数据空间中，一个单位平方在渲染时被缩放为 sizes**2 点。

**kwargs

转发至 Collection。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_sizes()

返回集合中元素的大小（'面积'）。

返回:

数组

每个元素的 '区域'。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

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], num=None)
plt.legend(*scatter.legend_elements())

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

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

参数:

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

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

num : int, None, "auto" (默认), 类数组, 或 Locatorint, None, "auto" (默认), 数组类, 或

要创建的元素目标数量。如果为 None，则使用 mappable 数组中的所有唯一元素。如果为整数，则在归一化范围内使用 num 个元素。如果为 "auto"，则尝试确定哪种选项更适合数据的性质。由于使用了 Locator 来查找有用的位置，创建的元素数量可能会略微偏离 num。如果为列表或数组，则使用这些元素来创建图例。最后，可以提供一个 Locator。

fmt : str, Formatter, 或 None (默认)字符串

用于标签的格式或格式化器。如果是一个字符串，必须是 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 的列表列表

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

标签list of str

图例元素的字符串标签。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sizes	numpy.ndarray 或 None
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(paths)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sizes(sizes, dpi=72.0)

设置集合中每个成员的大小。

参数:

sizes : numpy.ndarray 或 Nonenumpy.ndarray 或 None

集合中每个元素要设置的大小。该值是元素的'面积'。

dpifloat, 默认值: 72

画布的dpi。

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.PolyCollection(verts, sizes=None, *, closed=True, **kwargs)

基类：_CollectionWithSizes

参数:

verts类似数组的列表

多边形序列 [verts0, verts1, ...] 中，每个元素 verts_i 定义了多边形 i 的顶点，作为一个形状为 (M, 2) 的二维类数组。

尺寸类似数组，默认：None

多边形的平方缩放因子。每个多边形的坐标 verts_i 乘以 sizes 中相应条目的平方根（即，sizes 指定面积的缩放）。缩放在艺术家主变换之前应用。

关闭bool, 默认值: True

是否应在末尾添加 CLOSEPOLY 连接以闭合多边形。

**kwargs

转发至 Collection。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_sizes()

返回集合中元素的大小（'面积'）。

返回:

数组

每个元素的 '区域'。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	类似数组的列表
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sizes	numpy.ndarray 或 None
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
verts	类似数组的列表
verts_and_codes	未知
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(verts, closed=True)

设置多边形的顶点。

参数:

verts类似数组的列表

多边形序列 [verts0, verts1, ...] 中，每个元素 verts_i 定义了多边形 i 的顶点，作为一个形状为 (M, 2) 的二维类数组。

关闭bool, 默认值: True

是否应在末尾添加 CLOSEPOLY 连接以闭合多边形。

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sizes(sizes, dpi=72.0)

设置集合中每个成员的大小。

参数:

sizes : numpy.ndarray 或 Nonenumpy.ndarray 或 None

集合中每个元素要设置的大小。该值是元素的'面积'。

dpifloat, 默认值: 72

画布的dpi。

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_verts(verts, closed=True)

设置多边形的顶点。

参数:

verts类似数组的列表

多边形序列 [verts0, verts1, ...] 中，每个元素 verts_i 定义了多边形 i 的顶点，作为一个形状为 (M, 2) 的二维类数组。

关闭bool, 默认值: True

是否应在末尾添加 CLOSEPOLY 连接以闭合多边形。

set_verts_and_codes(verts, codes)

使用路径代码初始化顶点。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.PolyQuadMesh(coordinates, **kwargs)

基类：_MeshData, PolyCollection

用于绘制四边形网格为单独多边形的类。

四边形网格是一个由 M 乘 N 个相邻四边形组成的网格，这些四边形通过一个 (M+1, N+1) 的顶点网格定义。四边形 (m, n) 由顶点定义如下

   (m+1, n) ----------- (m+1, n+1)
      /                   /
     /                 /
    /               /
(m, n) -------- (m, n+1)

网格不必是规则的，多边形也不必是凸的。

参数:

坐标(M+1, N+1, 2) 类数组

顶点。 coordinates[m, n] 指定了顶点 (m, n) 的 (x, y) 坐标。

注释

与 QuadMesh 不同，此类将每个单元格绘制为单独的多边形。这会显著变慢，但在希望为单元格添加额外属性（如阴影）时提供了更大的灵活性。

与 QuadMesh 的另一个不同之处在于，如果一个单元格的任何顶点或数据被屏蔽，该多边形将 不会 被绘制，并且不会出现在返回的路径列表中。

参数:

verts类似数组的列表

多边形序列 [verts0, verts1, ...] 中，每个元素 verts_i 定义了多边形 i 的顶点，作为一个形状为 (M, 2) 的二维类数组。

尺寸类似数组，默认：None

多边形的平方缩放因子。每个多边形的坐标 verts_i 乘以 sizes 中相应条目的平方根（即，sizes 指定面积的缩放）。缩放在艺术家主变换之前应用。

关闭bool, 默认值: True

是否应在末尾添加 CLOSEPOLY 连接以闭合多边形。

**kwargs

转发至 Collection。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_coordinates()

返回网格的顶点作为一个 (M+1, N+1, 2) 数组。

M, N 是网格行/列中四边形的数量，对应于 (M+1, N+1) 个顶点。最后一个维度指定组件 (x, y)。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_sizes()

返回集合中元素的大小（'面积'）。

返回:

数组

每个元素的 '区域'。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	未知
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	类似数组的列表
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sizes	numpy.ndarray 或 None
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
verts	类似数组的列表
verts_and_codes	未知
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

设置数据值。

参数:

A类似数组

网格数据。支持的数组形状有：

• (M, N) 或 (M*N,): 一个带有标量数据的网格。这些值通过归一化和颜色映射映射到颜色。参见参数 norm、cmap、vmin、vmax。

• (M, N, 3): 一张带有RGB值（0-1浮点数或0-255整数）的图像。

• (M, N, 4): 一张包含RGBA值（0-1浮点数或0-255整数）的图像，即包括透明度。

如果值以二维网格形式提供，其形状必须与坐标网格匹配。如果值是一维的，它们将被重塑为二维。M, N 从坐标网格中得出，其中坐标网格形状为 'gouraud' 着色 时是 (M, N)，为 'flat' 着色时是 (M+1, N+1)。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(verts, closed=True)

设置多边形的顶点。

参数:

verts类似数组的列表

多边形序列 [verts0, verts1, ...] 中，每个元素 verts_i 定义了多边形 i 的顶点，作为一个形状为 (M, 2) 的二维类数组。

关闭bool, 默认值: True

是否应在末尾添加 CLOSEPOLY 连接以闭合多边形。

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sizes(sizes, dpi=72.0)

设置集合中每个成员的大小。

参数:

sizes : numpy.ndarray 或 Nonenumpy.ndarray 或 None

集合中每个元素要设置的大小。该值是元素的'面积'。

dpifloat, 默认值: 72

画布的dpi。

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_verts(verts, closed=True)

设置多边形的顶点。

参数:

verts类似数组的列表

多边形序列 [verts0, verts1, ...] 中，每个元素 verts_i 定义了多边形 i 的顶点，作为一个形状为 (M, 2) 的二维类数组。

关闭bool, 默认值: True

是否应在末尾添加 CLOSEPOLY 连接以闭合多边形。

set_verts_and_codes(verts, codes)

使用路径代码初始化顶点。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.QuadMesh(coordinates, *, antialiased=True, shading='flat', **kwargs)

基类：_MeshData, Collection

用于高效绘制四边形网格的类。

四边形网格是一个由 M 乘 N 个相邻四边形组成的网格，这些四边形通过一个 (M+1, N+1) 的顶点网格定义。四边形 (m, n) 由顶点定义如下

   (m+1, n) ----------- (m+1, n+1)
      /                   /
     /                 /
    /               /
(m, n) -------- (m, n+1)

网格不必是规则的，多边形也不必是凸的。

参数:

坐标(M+1, N+1, 2) 类数组

顶点。 coordinates[m, n] 指定了顶点 (m, n) 的 (x, y) 坐标。

抗锯齿bool, 默认值: True

着色{'flat', 'gouraud'}, 默认: 'flat'

注释

与其他 Collection 不同，QuadMesh 的默认 pickradius 为 0，即 contains 检查测试点是否在任何网格四边形内。

参数:

edgecolors : color 或颜色列表，默认值: rcParams["patch.edgecolor"] (default: 'black')颜色或颜色列表，默认值：rcParams["patch.edgecolor"]（默认值：'black'）

构成集合的每个补丁的边缘颜色。可以传递特殊值 'face' 以使边缘颜色与面颜色匹配。

facecolors : color 或颜色列表, 默认值: rcParams["patch.facecolor"] (default: 'C0')颜色或颜色列表，默认值: rcParams["patch.facecolor"] (默认: 'C0')

构成集合的每个补丁的面颜色。

linewidths : float 或 float 列表, 默认值: rcParams["patch.linewidth"] (default: 1.0)浮点数或浮点数列表，默认值：

构成集合的每个补丁的行宽。

线型str 或 tuple 或其列表，默认值：'solid'

有效的字符串是 ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']。虚线元组应为以下形式:

(offset, onoffseq),

其中 onoffseq 是一个偶数长度的元组，包含点和点之间的墨水长度。有关示例，请参见 线条样式。

capstyle : 类似 CapStyle 的类型, 默认值: rcParams["patch.capstyle"]CapStyle-like, 默认值: rcParams["patch.capstyle"]

用于集合中所有路径的线帽样式。允许的值有 {'butt', 'projecting', 'round'}。

joinstyle : 类似 JoinStyle 的, 默认值: rcParams["patch.joinstyle"]JoinStyle-like, 默认值: rcParams["patch.joinstyle"]

用于连接集合中所有路径的线条样式的样式。允许的值为 {'miter', 'round', 'bevel'}。

antialiaseds : bool 或 bool 列表, 默认值: rcParams["patch.antialiased"] (default: True)布尔值或布尔值列表，默认值：

集合中的每个补丁是否应使用抗锯齿绘制。

偏移量(float, float) 或其列表，默认值：(0, 0)

在渲染后用于平移每个补丁的向量（默认不进行平移）。平移操作在屏幕（像素）坐标系中进行（即在应用了艺术家的变换之后）。

offset_transform : Transform, 默认: IdentityTransform变换，默认：IdentityTransform

在每个 offsets 向量被使用之前，将应用的单一变换。

cmap, norm

数据归一化和颜色映射参数。详细描述请参见 ScalarMappable。

hatchstr, 可选

填充路径中使用的填充图案（如果有）。有效的字符串包括 ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']。有关每种填充类型的含义，请参阅 Hatch 样式参考。

pickradiusfloat, 默认值: 5.0

如果 pickradius <= 0，那么当测试点位于集合中路径的控制点形成的多边形内部时，Collection.contains 将返回 True。另一方面，如果它大于 0，那么我们将检查测试点是否包含在集合中任意路径的宽度为 2*pickradius 的笔画内。

网址list of str, 默认: None

每个补丁在绘制后链接到的URL。目前仅适用于SVG后端。有关示例，请参见 超链接。

zorderfloat, 默认值: 1

绘图顺序，由集合中的所有补丁共享。查看 Zorder 演示 以获取所有默认值和示例。

**kwargs

剩余的关键字参数将用于为 kwargs 中的每个键值对设置属性，如 Collection.set_{key}(val)。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_coordinates()

返回网格的顶点作为一个 (M+1, N+1, 2) 数组。

M, N 是网格行/列中四边形的数量，对应于 (M+1, N+1) 个顶点。最后一个维度指定组件 (x, y)。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类似数组
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

设置数据值。

参数:

A类似数组

网格数据。支持的数组形状有：

• (M, N) 或 (M*N,): 一个带有标量数据的网格。这些值通过归一化和颜色映射映射到颜色。参见参数 norm、cmap、vmin、vmax。

• (M, N, 3): 一张带有RGB值（0-1浮点数或0-255整数）的图像。

• (M, N, 4): 一张包含RGBA值（0-1浮点数或0-255整数）的图像，即包括透明度。

如果值以二维网格形式提供，其形状必须与坐标网格匹配。如果值是一维的，它们将被重塑为二维。M, N 从坐标网格中得出，其中坐标网格形状为 'gouraud' 着色 时是 (M, N)，为 'flat' 着色时是 (M+1, N+1)。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths()

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.RegularPolyCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)

基类：_CollectionWithSizes

一组n边正多边形。

参数:

numsides整数

多边形的边数。

旋转float

多边形旋转的弧度。

尺寸浮点数元组

圆的外接多边形的面积，单位为点^2。

**kwargs

转发至 Collection。

示例

参见 Lasso 演示 以获取完整示例:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    offset_transform=ax.transData,
    )

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_numsides()

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_rotation()

get_sizes()

返回集合中元素的大小（'面积'）。

返回:

数组

每个元素的 '区域'。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sizes	numpy.ndarray 或 None
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(paths)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sizes(sizes, dpi=72.0)

设置集合中每个成员的大小。

参数:

sizes : numpy.ndarray 或 Nonenumpy.ndarray 或 None

集合中每个元素要设置的大小。该值是元素的'面积'。

dpifloat, 默认值: 72

画布的dpi。

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.StarPolygonCollection(numsides, *, rotation=0, sizes=(1,), **kwargs)

基类：RegularPolyCollection

绘制一组具有 numsides 个顶点的正星形。

参数:

numsides整数

多边形的边数。

旋转float

多边形旋转的弧度。

尺寸浮点数元组

圆的外接多边形的面积，单位为点^2。

**kwargs

转发至 Collection。

示例

参见 Lasso 演示 以获取完整示例:

offsets = np.random.rand(20, 2)
facecolors = [cm.jet(x) for x in np.random.rand(20)]

collection = RegularPolyCollection(
    numsides=5, # a pentagon
    rotation=0, sizes=(50,),
    facecolors=facecolors,
    edgecolors=("black",),
    linewidths=(1,),
    offsets=offsets,
    offset_transform=ax.transData,
    )

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_numsides()

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_rotation()

get_sizes()

返回集合中元素的大小（'面积'）。

返回:

数组

每个元素的 '区域'。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
路径	未知
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sizes	numpy.ndarray 或 None
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths(paths)

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sizes(sizes, dpi=72.0)

设置集合中每个成员的大小。

参数:

sizes : numpy.ndarray 或 Nonenumpy.ndarray 或 None

集合中每个元素要设置的大小。该值是元素的'面积'。

dpifloat, 默认值: 72

画布的dpi。

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0

class matplotlib.collections.TriMesh(triangulation, **kwargs)

基类：Collection

用于使用 Gouraud 着色高效绘制三角形网格的类。

三角网格是一个 Triangulation 对象。

参数:

edgecolors : color 或颜色列表，默认值: rcParams["patch.edgecolor"] (default: 'black')颜色或颜色列表，默认值：rcParams["patch.edgecolor"]（默认值：'black'）

构成集合的每个补丁的边缘颜色。可以传递特殊值 'face' 以使边缘颜色与面颜色匹配。

facecolors : color 或颜色列表, 默认值: rcParams["patch.facecolor"] (default: 'C0')颜色或颜色列表，默认值: rcParams["patch.facecolor"] (默认: 'C0')

构成集合的每个补丁的面颜色。

linewidths : float 或 float 列表, 默认值: rcParams["patch.linewidth"] (default: 1.0)浮点数或浮点数列表，默认值：

构成集合的每个补丁的行宽。

线型str 或 tuple 或其列表，默认值：'solid'

有效的字符串是 ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':']。虚线元组应为以下形式:

(offset, onoffseq),

其中 onoffseq 是一个偶数长度的元组，包含点和点之间的墨水长度。有关示例，请参见 线条样式。

capstyle : 类似 CapStyle 的类型, 默认值: rcParams["patch.capstyle"]CapStyle-like, 默认值: rcParams["patch.capstyle"]

用于集合中所有路径的线帽样式。允许的值有 {'butt', 'projecting', 'round'}。

joinstyle : 类似 JoinStyle 的, 默认值: rcParams["patch.joinstyle"]JoinStyle-like, 默认值: rcParams["patch.joinstyle"]

用于连接集合中所有路径的线条样式的样式。允许的值为 {'miter', 'round', 'bevel'}。

antialiaseds : bool 或 bool 列表, 默认值: rcParams["patch.antialiased"] (default: True)布尔值或布尔值列表，默认值：

集合中的每个补丁是否应使用抗锯齿绘制。

偏移量(float, float) 或其列表，默认值：(0, 0)

在渲染后用于平移每个补丁的向量（默认不进行平移）。平移操作在屏幕（像素）坐标系中进行（即在应用了艺术家的变换之后）。

offset_transform : Transform, 默认: IdentityTransform变换，默认：IdentityTransform

在每个 offsets 向量被使用之前，将应用的单一变换。

cmap, norm

数据归一化和颜色映射参数。详细描述请参见 ScalarMappable。

hatchstr, 可选

填充路径中使用的填充图案（如果有）。有效的字符串包括 ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*']。有关每种填充类型的含义，请参阅 Hatch 样式参考。

pickradiusfloat, 默认值: 5.0

如果 pickradius <= 0，那么当测试点位于集合中路径的控制点形成的多边形内部时，Collection.contains 将返回 True。另一方面，如果它大于 0，那么我们将检查测试点是否包含在集合中任意路径的宽度为 2*pickradius 的笔画内。

网址list of str, 默认: None

每个补丁在绘制后链接到的URL。目前仅适用于SVG后端。有关示例，请参见 超链接。

zorderfloat, 默认值: 1

绘图顺序，由集合中的所有补丁共享。查看 Zorder 演示 以获取所有默认值和示例。

**kwargs

剩余的关键字参数将用于为 kwargs 中的每个键值对设置属性，如 Collection.set_{key}(val)。

add_callback(func)

添加一个回调函数，该函数将在 Artist 的任一属性更改时被调用。

参数:

函数可调用

回调函数。它必须具有以下签名:

def func(artist: Artist) -> Any

其中 artist 是调用的 Artist。返回值可能存在但会被忽略。

返回:

整数

与回调关联的观察者ID。此ID稍后可用于通过 remove_callback 移除回调。

参见

remove_callback

autoscale()

使用当前数组自动缩放范数实例上的标量限制

autoscale_None()

使用当前数组自动缩放范数实例上的标量限制，仅更改值为 None 的限制。

property axes

艺术家所在的 Axes 实例，或 None。

changed()

每当可映射对象发生变化时调用此函数，以通知所有监听 'changed' 信号的回调SM监听器。

colorbar

与此 ScalarMappable 关联的最后一个颜色条。可能是 None。

contains(mouseevent)

测试鼠标事件是否发生在集合中。

返回 bool, dict(ind=itemlist)，其中 itemlist 中的每个项目都包含该事件。

static convert_mesh_to_paths(tri)

将给定的网格转换为一系列 Path 对象。

此功能主要用于不直接支持网格的后端实现者。

convert_xunits(x)

使用 x 轴的单位类型转换 x。

如果艺术家不在 Axes 中，或者 x 轴没有单位，则返回 x 本身。

convert_yunits(y)

使用 y 轴的单位类型转换 y。

如果艺术家不在 Axes 中，或者 yaxis 没有单位，则返回 y 本身。

draw(renderer)

使用给定的渲染器绘制艺术家（及其子项）。

如果艺术家不可见（Artist.get_visible 返回 False），则此操作无效。

参数:

渲染器 : RendererBase 子类。RendererBase 子类。

注释

此方法在 Artist 子类中被重写。

property figure

艺术家所在的（子）图。为了获得更多控制，请使用 get_figure 方法。

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找艺术家中包含的所有 Artist 实例。

参数:

匹配

匹配项的过滤标准。这可以是

• None: 返回艺术家包含的所有对象。

• 一个带有签名 def match(artist: Artist) -> bool 的函数。结果将仅包含函数返回 True 的艺术家。

• 一个类实例：例如，Line2D。结果将仅包含此类或其子类的艺术家（isinstance 检查）。

include_self布尔

在列表中包含 self 以检查是否匹配。

返回:

Artist 列表

format_cursor_data(data)

返回 data 的字符串表示。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

默认实现将整数、浮点数以及整数和浮点数的数组转换为方括号包围的逗号分隔字符串，除非艺术家有关联的颜色条，在这种情况下，标量值使用颜色条的格式化器进行格式化。

参见

get_cursor_data

get_aa()

get_antialiased 的别名。

get_agg_filter()

返回用于聚合过滤的过滤函数。

get_alpha()

返回用于混合的 alpha 值 - 并非所有后端都支持。

get_animated()

返回艺术家是否为动画。

get_antialiased()

获取渲染的抗锯齿状态。

返回:

布尔数组

get_antialiaseds()

get_antialiased 的别名。

get_array()

返回映射到颜色的值数组。

基类 ScalarMappable 不对数组的维度和形状做任何假设。

get_capstyle()

返回集合的帽样式（适用于其所有元素）。

返回:

{'butt', 'projecting', 'round'} 或 None

get_children()

返回此 Artist 的子 Artist 列表。

get_clim()

返回映射到颜色图限制的值（最小值，最大值）。

get_clip_box()

返回剪辑框。

get_clip_on()

返回艺术家是否使用剪裁。

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_cursor_data(event)

返回给定事件的光标数据。

备注

此方法旨在由艺术家子类重写。作为 Matplotlib 的最终用户，您很可能不会自己调用此方法。

光标数据可以被艺术家用来为特定事件提供额外的上下文信息。默认实现仅返回 None。

子类可以重写该方法并返回任意数据。然而，在这样做时，它们必须确保 format_cursor_data 能够将数据转换为字符串表示。

当前唯一的用例是在移动鼠标时，在绘图窗口的状态栏中显示 AxesImage 的 z 值。

参数:

事件 : MouseEvent鼠标事件

参见

format_cursor_data

get_dashes()

get_linestyle 的别名。

get_datalim(transData)

get_ec()

get_edgecolor 的别名。

get_edgecolor()

get_edgecolors()

get_edgecolor 的别名。

get_facecolor()

get_facecolors()

get_facecolor 的别名。

get_fc()

get_facecolor 的别名。

get_figure(root=False)

返回艺术家所属的 Figure 或 SubFigure 实例。

参数:

根bool, 默认=False

如果为 False，返回该艺术家所在的（子）图。如果为 True，返回子图嵌套树的根图。

get_fill()

返回人脸是否着色。

get_gid()

返回组ID。

get_hatch()

返回当前的阴影图案。

get_in_layout()

返回布尔标志，如果艺术家包含在布局计算中，则返回 True。

例如 约束布局指南 、 Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') 。

get_joinstyle()

返回集合的连接样式（适用于其所有元素）。

返回:

{'miter', 'round', 'bevel'} 或 None

get_label()

返回在图例中用于此艺术家的标签。

get_linestyle()

get_linestyles()

get_linestyle 的别名。

get_linewidth()

get_linewidths()

get_linewidth 的别名。

get_ls()

get_linestyle 的别名。

get_lw()

get_linewidth 的别名。

get_mouseover()

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

get_offset_transform()

返回此艺术家偏移使用的 Transform 实例。

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的选取行为。

可能的值在 Artist.set_picker 中描述。

参见

Artist.set_picker, Artist.pickable, Artist.pick

get_pickradius()

get_rasterized()

返回艺术家是否将被光栅化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

一个包含以下元素的3元组：

• scale: 垂直于源线的摆动的振幅。

• length: 沿线的摆动长度。

• randomness: 长度被缩小或扩展的比例因子。

如果没有设置草图参数，则返回 None。

get_snap()

返回快照设置。

详情请参见 set_snap。

get_tightbbox(renderer=None)

类似于 Artist.get_window_extent，但包括任何裁剪。

参数:

渲染器 : RendererBase 子类, 可选RendererBase 子类，可选

用于绘制图形的渲染器（例如 fig.canvas.get_renderer()）

返回:

Bbox 或 None

包围的边界框（在图像像素坐标中）。如果裁剪结果没有交集，则返回 None。

get_transOffset()

get_offset_transform 的别名。

get_transform()

返回此艺术家使用的 Transform 实例。

get_transformed_clip_path_and_affine()

返回应用了其非仿射变换部分的剪辑路径，以及剩余的仿射变换部分。

get_transforms()

get_url()

返回URL。

get_urls()

返回一个URL列表，每个元素对应集合中的一个URL。

列表中包含 None 表示没有URL的元素。示例请参见 超链接。

get_visible()

返回可见性。

get_window_extent(renderer=None)

获取艺术家在显示空间中的边界框。

边界框的宽度和高度是非负的。

子类应重写以包含在边界框“紧”计算中。默认是返回一个位于0, 0的空边界框。

使用此功能时要小心，如果艺术家的窗口范围发生变化，结果将不会更新。范围可能会因变换堆栈中的任何更改而变化，例如更改轴的限制、图形大小或使用的画布（如保存图形时所做的那样）。这可能导致意外行为，即交互式图形在屏幕上看起来正常，但保存时会出现错误。

get_zorder()

返回艺术家的zorder。

have_units()

返回是否在任何轴上设置了单位。

is_transform_set()

返回 Artist 是否具有显式设置的变换。

在调用 set_transform 之后，这是 True。

property mouseover

当鼠标光标移动到该艺术家上时，返回是否查询该艺术家的自定义上下文信息。

property norm

!! 由 numpydoc 处理 !!

pchanged()

调用所有已注册的回调函数。

当属性发生变化时，此函数会在内部被触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理一个拾取事件。

如果 mouseevent 在艺术家上，并且艺术家设置了选择器，每个子艺术家将触发一个选择事件。

参见

Artist.set_picker, Artist.get_picker, Artist.pickable

pickable()

返回艺术家是否可选中。

参见

Artist.set_picker, Artist.get_picker, Artist.pick

properties()

返回一个包含艺术家所有属性的字典。

remove()

如果可能，从图形中移除艺术家。

效果在图形重新绘制之前不会显示，例如使用 FigureCanvasBase.draw_idle。如果需要，调用 relim 来更新 Axes 的限制。

注意：即使集合是通过 autolim = True 添加到 Axes 中的，relim 也不会看到集合。

注意：不支持移除艺术家的图例条目。

remove_callback(oid)

根据观察者ID移除回调。

参见

add_callback

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

一次性设置多个属性。

支持的属性有

属性	描述
agg_filter	一个过滤函数，它接收一个 (m, n, 3) 的浮点数组和一个 dpi 值，并返回一个 (m, n, 3) 数组和两个从图像左下角开始的偏移量
alpha	类似数组或标量或无
animated	布尔
抗锯齿 或 aa 或 antialiaseds	布尔值或布尔值列表
数组	类数组或无
capstyle	CapStyle 或 {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	BboxBase 或 None
clip_on	布尔
clip_path	补丁或（路径，变换）或无
cmap	Colormap 或 str 或 None
颜色	color 或 RGBA 元组列表
edgecolor 或 ec 或 edgecolors	color 或 color 列表 或 'face'
facecolor 或 facecolors 或 fc	color 或 color 列表
figure	Figure 或 SubFigure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	布尔
joinstyle	JoinStyle 或 {'miter', 'round', 'bevel'}
标签	对象
linestyle 或虚线或线型或 ls	str 或 tuple 或其列表
linewidth 或 linewidths 或 lw	浮点数或浮点数列表
鼠标悬停	布尔
norm	Normalize 或 str 或 None
offset_transform 或 transOffset	Transform
偏移量	(N, 2) 或 (2,) 数组类
path_effects	AbstractPathEffect 列表
picker	None 或 bool 或 float 或 callable
pickradius	float
光栅化	布尔
sketch_params	(scale: float, length: float, randomness: float)
snap	布尔值或无
transform	Transform
url	str
urls	list of str 或 None
可见	布尔
zorder	float

set_aa(aa)

set_antialiased 的别名。

set_agg_filter(filter_func)

设置 agg 过滤器。

参数:

filter_func可调用

一个过滤函数，它接受一个 (m, n, depth) 浮点数组和一个 dpi 值，并返回一个 (m, n, depth) 数组和图像左下角的两个偏移量

set_alpha(alpha)

设置用于混合的 alpha 值 - 并非所有后端都支持。

参数:

alpha类似数组或标量或无

所有值必须在 0-1 范围内，包括 0 和 1。不支持掩码值和 nans。

set_animated(b)

设置艺术家是否用于动画中。

如果为 True，该艺术家将从图形的常规绘制中排除。您必须显式调用 Figure.draw_artist / Axes.draw_artist 来绘制该艺术家。这种方法用于通过 blitting 加速动画。

另请参阅 matplotlib.animation 和 通过使用 blitting 实现更快的渲染。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔值或布尔值列表

set_antialiaseds(aa)

set_antialiased 的别名。

set_array(A)

从类数组 A 中设置值数组。

参数:

A类数组或无

映射到颜色的值。

基类 ScalarMappable 不对值数组 A 的维度和形状做任何假设。

set_capstyle(cs)

为集合设置 `.CapStyle`（适用于其所有元素）。

参数:

cs : CapStyle 或 {'butt', 'projecting', 'round'}CapStyle 或 {'butt', 'projecting', 'round'}

set_clim(vmin=None, vmax=None)

设置图像缩放的规范限制。

参数:

vmin, vmaxfloat

限制。

限制也可以作为元组 (vmin, vmax) 作为单个位置参数传递。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox。

参数:

clipbox : BboxBase 或 NoneBboxBase 或 None

通常由 TransformedBbox 创建。例如，TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) 是添加到 Axes 的艺术家默认的剪辑区域。

set_clip_on(b)

设置艺术家是否使用剪裁。

当为 False 时，艺术家将在 Axes 外部可见，这可能导致意外结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪切路径。

参数:

路径 : Patch 或 Path 或 TransformedPath 或 None补丁或路径或变换路径或无

剪切路径。如果给定一个 Path，则必须同时提供 transform。如果为 None，则移除之前设置的剪切路径。

变换 : Transform, 可选转换，可选

仅在 path 是 Path 时使用，在这种情况下，给定的 Path 使用 transform 转换为 TransformedPath。

注释

为了提高效率，如果 path 是一个 Rectangle，此方法将把裁剪框设置为相应的矩形，并将裁剪路径设置为 None。

出于技术原因（支持 set），一个元组（路径, 变换）也可以作为单一位置参数被接受。

set_cmap(cmap)

设置亮度数据的色图。

参数:

cmap : Colormap 或 str 或 NoneColormap 或 str 或 None

set_color(c)

设置边缘颜色和表面颜色。

参数:

c : color 或 RGBA 元组列表颜色或 RGBA 元组列表

参见

Collection.set_facecolor, Collection.set_edgecolor

用于单独设置边或面的颜色。

set_dashes(ls)

set_linestyle 的别名。

set_ec(c)

set_edgecolor 的别名。

set_edgecolor(c)

设置集合的边缘颜色。

参数:

c : color 或 color 列表 或 'face'颜色或颜色列表或'face'

集合边缘颜色。如果是序列，补丁将循环使用它。如果是 'face'，则匹配面颜色。

set_edgecolors(c)

set_edgecolor 的别名。

set_facecolor(c)

设置集合的面部颜色。c 可以是一种颜色（所有补丁具有相同颜色），或者是一系列颜色；如果它是一系列颜色，补丁将循环通过这些颜色。

如果 c 是 'none'，则补丁将不会被填充。

参数:

c : color 或 color 列表颜色或颜色列表

set_facecolors(c)

set_facecolor 的别名。

set_fc(c)

set_facecolor 的别名。

set_figure(fig)

设置艺术家所属的 Figure 或 SubFigure 实例。

参数:

fig : Figure 或 SubFigure图或子图

set_gid(gid)

设置艺术家的（组）ID。

参数:

gidstr

set_hatch(hatch)

设置填充图案

hatch 可以是以下之一:

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

字母可以组合使用，在这种情况下，所有指定的阴影线都会被绘制。如果相同的字母重复出现，它会提高该图案的阴影密度。

与其他属性（如线宽和颜色）不同，阴影只能为整个集合指定，而不能为每个成员单独指定。

参数:

hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

set_in_layout(in_layout)

设置是否将艺术家包含在布局计算中，例如：约束布局指南、Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight')。

参数:

in_layout布尔

set_joinstyle(js)

为集合设置 `.JoinStyle`（适用于其所有元素）。

参数:

js : JoinStyle 或 {'miter', 'round', 'bevel'}JoinStyle 或 {'miter', 'round', 'bevel'}

set_label(s)

设置一个将在图例中显示的标签。

参数:

s对象

s 将通过调用 str 转换为字符串。

set_linestyle(ls)

设置集合的线条样式。

linestyle	描述
'-' 或 'solid'	实线
'--' 或 'dashed'	虚线
'-.' 或 'dashdot'	虚点线
':' 或 'dotted'	虚线

或者可以提供以下形式的破折号元组:

(offset, onoffseq),

其中 onoffseq 是一个长度为偶数的元组，表示点和墨水的开和关。

参数:

lsstr 或 tuple 或其列表

单个线条样式的有效值包括 {'-', '--', '-.', ':', '', (offset, on-off-seq)}。完整描述请参见 Line2D.set_linestyle。

set_linestyles(ls)

set_linestyle 的别名。

set_linewidth(lw)

设置集合的线宽。lw 可以是一个标量或一个序列；如果它是一个序列，补丁将循环通过该序列。

参数:

lw浮点数或浮点数列表

set_linewidths(lw)

set_linewidth 的别名。

set_ls(ls)

set_linestyle 的别名。

set_lw(lw)

set_linewidth 的别名。

set_mouseover(mouseover)

设置当鼠标光标移动到该艺术家上时，是否查询其自定义上下文信息。

参数:

鼠标悬停布尔

参见

get_cursor_data

ToolCursorPosition

NavigationToolbar2

set_norm(norm)

设置归一化实例。

参数:

norm : Normalize 或 str 或 None标准化或字符串或无

注释

如果存在使用此规范的 mappable 的颜色条，设置 mappable 的规范将重置颜色条的规范、定位器和格式化器为默认值。

set_offset_transform(offset_transform)

设置艺术家的偏移变换。

参数:

offset_transform变换

set_offsets(offsets)

设置集合的偏移量。

参数:

偏移量(N, 2) 或 (2,) 数组类

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects : AbstractPathEffect 的列表列表

set_paths()

set_picker(picker)

定义艺术家的选择行为。

参数:

选择器None 或 bool 或 float 或 callable

这可以是以下之一：

• None: 此艺术家的选择功能被禁用（默认）。

• 一个布尔值：如果为 True ，则将启用拾取功能，并且如果鼠标事件在艺术家上方，艺术家将触发拾取事件。

• 一个浮点数：如果 picker 是一个数字，它被解释为一个以点为单位的 epsilon 容差，并且如果其数据在鼠标事件的 epsilon 范围内，艺术家将触发一个事件。对于某些艺术家，如线条和补丁集合，艺术家可能会为生成的拾取事件提供额外的数据，例如，在拾取事件的 epsilon 范围内的数据的索引。

• 一个函数：如果 picker 是可调用的，它是一个用户提供的函数，用于确定艺术家是否被鼠标事件击中:

  hit, props = picker(artist, mouseevent)
  

  确定命中测试。如果鼠标事件在艺术家上方，返回 hit=True 并且 props 是一个字典，包含你希望添加到 PickEvent 属性的属性。

set_pickradius(pickradius)

设置用于包含测试的选择半径。

参数:

pickradiusfloat

选择半径，以点为单位。

set_rasterized(rasterized)

强制为矢量图形输出使用光栅化（位图）绘图。

光栅化绘图并不被所有艺术家支持。如果你尝试在一个不支持此功能的艺术家上启用它，该命令将无效并会发出警告。

此设置对基于像素的输出无效。

另请参阅 矢量图形的栅格化。

参数:

光栅化布尔

set_sketch_params(scale=None, length=None, randomness=None)

设置草图参数。

参数:

比例浮点数，可选

垂直于源线的摆动幅度，以像素为单位。如果比例为 None，或未提供，则不会提供草图滤镜。

长度浮点数，可选

沿线条的摆动长度，以像素为单位（默认 128.0）

随机性浮点数，可选

长度被缩小或扩大的比例因子（默认值为16.0）

PGF 后端使用此参数作为 RNG 种子，而不是如上所述。使用相同的种子会生成相同的随机形状。

set_snap(snap)

设置捕捉行为。

对齐位置与像素网格，从而产生更清晰的图像。例如，如果一条1像素宽的黑色线条定义在两个像素之间的位置，生成的图像将包含该线条在像素网格中的插值，这将导致两个相邻像素位置上出现灰色值。相比之下，对齐会将线条移动到最近的整数像素值，因此生成的图像将真正包含一条1像素宽的黑色线条。

目前，捕捉功能仅由 Agg 和 MacOSX 后端支持。

参数:

快照布尔值或无

可能的值：

• True: 将顶点捕捉到最近的像素中心。

• False: 不要修改顶点位置。

• None: (自动) 如果路径仅包含直线段，则四舍五入到最近的像素中心。

set_transOffset(offset_transform)

set_offset_transform 的别名。

set_transform(t)

设置艺术家变换。

参数:

t变换

set_url(url)

设置艺术家的URL。

参数:

网址str

set_urls(urls)

参数:

网址list of str 或 None

注释

URL 目前仅由 SVG 后端实现。它们被所有其他后端忽略。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

设置艺术家的zorder。zorder值较低的艺术家会先被绘制。

参数:

级别float

property stale

艺术家是否'过时'，需要重新绘制以使输出与艺术家的内部状态匹配。

property sticky_edges

x 和 y 粘性边缘列表用于自动缩放。

在进行自动缩放时，如果一个数据限制与相应的 sticky_edges 列表中的值一致，那么不会添加边距——视图限制会“粘”在边缘。一个典型的用例是直方图，通常人们期望直方图的底部边缘（0）没有边距。

此外，边距扩展 "碰撞" 到粘性边缘并且不能跨越它们。例如，如果上数据限制是 1.0，通过简单边距应用计算的上视图限制是 1.2，但有一个粘性边缘在 1.1，那么实际的上视图限制将是 1.1。

此属性不可赋值；然而，x 和 y 列表可以根据需要就地修改。

示例

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

to_rgba(x, alpha=None, bytes=False, norm=True)

返回与 x 对应的归一化 RGBA 数组。

在正常情况下，x 是一个一维或二维的标量序列，将根据为该 ScalarMappable 设置的范数和颜色映射返回相应的 ndarray 的 RGBA 值。

有一种特殊情况，用于处理已经是 RGB 或 RGBA 的图像，例如可能从图像文件中读取的图像。如果 x 是一个 ndarray 并且有 3 个维度，且最后一个维度是 3 或 4，那么它将被视为 RGB 或 RGBA 数组，并且不会进行映射。数组可以是 uint8，或者可以是值在 0-1 范围内的浮点数；否则将引发 ValueError。任何 NaN 或掩码元素将被设置为 0 透明度。如果最后一个维度是 3，则 alpha 关键字参数（默认为 1）将用于填充透明度。如果最后一个维度是 4，则 alpha 关键字参数将被忽略；它不会替换现有的透明度。如果第三个维度不是 3 或 4，将引发 ValueError。

在任何情况下，如果 bytes 是 False*（默认），RGBA 数组将是 0-1 范围内的浮点数；如果它是 *True，返回的 RGBA 数组将是 uint8 类型，范围在 0 到 255 之间。

如果 norm 为 False，则不对输入数据进行归一化处理，并假定其范围为 (0-1)。

update(props)

从字典 props 更新此艺术家的属性。

参数:

属性dict

update_from(other)

从其他对象复制属性到自身。

update_scalarmappable()

如果有标量映射数组，则更新颜色。

根据数组和/或直接设置的颜色，适当地为边和面分配颜色。

zorder = 0