matplotlib.collections

类，用于高效地绘制共享大多数属性的大型对象集合，例如大量线段或多边形。

这些类并不像它们的单一元素对应的那样灵活（例如，您可能无法选择所有的线样式），但是它们对于常见的用例（例如，一组大的实线线段）来说是快速的。

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

基类：matplotlib.collections.RegularPolyCollection

绘制常规星号集合 纽曼斯 点。

参数:

numsides利息

多边形的边数。

rotation浮动

多边形以弧度为单位的旋转。

sizes浮点元组

在点^2中包围多边形的圆的面积。

**kwargs

转发至 Collection .

实例

见 套索演示 举个完整的例子：

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,
    transOffset=ax.transData,
    )

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_numsides()

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_rotation()

get_sizes()

返回集合中元素的大小（“区域”）。

返回:

数组

每个元素的“面积”。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths()

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

set_sizes(sizes, dpi=72.0)

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

参数:

sizes无或无

要为集合的每个元素设置的大小。该值是元素的“区域”。

dpi浮动，默认值：72

画布的dpi。

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

class matplotlib.collections.BrokenBarHCollection(xranges, yrange, **kwargs)

基类：matplotlib.collections.PolyCollection

横杆跨越的集合 雅温特 一系列的 X射线测距仪 .

参数:

xranges列表（float，float）

每个条的（左边缘位置、宽度）对的顺序。

yrange（浮标，浮标）

所有钢筋共用的（下边缘、高度）。

**kwargs

转发至 Collection .

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_sizes()

返回集合中元素的大小（“区域”）。

返回:

数组

每个元素的“面积”。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths(verts, closed=True)

设置多边形的顶点。

参数:

verts类数组列表

多边形序列 [verts0, verts1, ...] 每个元素 verts_i 定义多边形的顶点 i 作为一个类似于形状（M，2）的二维数组。

closedbool，默认值：True

是否应该通过在末端添加CLOSEPOLY连接来闭合多边形。

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

set_sizes(sizes, dpi=72.0)

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

参数:

sizes无或无

要为集合的每个元素设置的大小。该值是元素的“区域”。

dpi浮动，默认值：72

画布的dpi。

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_verts(verts, closed=True)

设置多边形的顶点。

参数:

verts类数组列表

多边形序列 [verts0, verts1, ...] 每个元素 verts_i 定义多边形的顶点 i 作为一个类似于形状（M，2）的二维数组。

closedbool，默认值：True

是否应该通过在末端添加CLOSEPOLY连接来闭合多边形。

set_verts_and_codes(verts, codes)

使用路径代码初始化顶点。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

classmethod span_where(x, ymin, ymax, where, **kwargs)

返回A BrokenBarHCollection 从中的区域绘制水平条 x 在哪里？ 在哪里？ 是True。条形在Y轴上的范围从 ymin 到 ymax

关键字参数 传递给集合。

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

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

基类：matplotlib.collections._CollectionWithSizes

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

参数:

sizes浮点数或类似数组的

以点^2表示的每个圆的面积。

**kwargs

转发至 Collection .

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_sizes()

返回集合中元素的大小（“区域”）。

返回:

数组

每个元素的“面积”。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths()

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

set_sizes(sizes, dpi=72.0)

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

参数:

sizes无或无

要为集合的每个元素设置的大小。该值是元素的“区域”。

dpi浮动，默认值：72

画布的dpi。

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_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, transOffset=None, norm=None, cmap=None, pickradius=5.0, hatch=None, urls=None, offset_position=<deprecated parameter>, zorder=1, **kwargs)

基类：matplotlib.artist.Artist, matplotlib.cm.ScalarMappable

集合的基类。必须子类化才能使用。

集合表示一系列 Patch 可以更有效地结合在一起而不是单独绘制的对象。例如，当以不同偏移重复绘制单个路径时，渲染器通常可以执行 draw_marker() 打电话比一系列重复的电话更有效 draw_path() 把偏移量一个接一个地放进去。

集合的大多数属性都可以按元素配置。因此，集合的许多属性都有“复数”版本 Patch （例如） Collection.get_paths 而不是 Patch.get_path ). 例外情况是 Z阶 ， 孵化 ， 拾取半径 ， 披风 和 连接方式 属性，只能为整个集合全局设置。

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

prop[i % len(prop)]

可以选择将每个集合用作自己的集合 ScalarMappable by passing the norm and cmap parameters to its constructor. If the Collection's ScalarMappable matrix _ 一个``已经设置好（通过调用 `.Collection.set_array` )，则在绘制时，此内部标量可映射将用于设置 ``facecolors 和 edgecolors ，忽略那些手动传入的。

参数:

绿色染料 : color or list of colors, default: rcParams["patch.edgecolor"] (default: 'black')颜色或颜色列表，默认值：

构成集合的每个补丁的边缘颜色。可以传递特殊值“face”，使edgecolor与facecolor匹配。

脸色 : color or list of colors, default: rcParams["patch.facecolor"] (default: 'C0')颜色或颜色列表，默认值：

构成系列的每个贴片的面部颜色。

线宽度 : float or list of floats, default: rcParams["patch.linewidth"] (default: 1.0)浮动或浮动列表，默认值：

组成集合的每个面片的线宽。

linestylesstr或tuple或其列表，默认值：“solid”

有效字符串是 ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':'] . 短划线元组的形式应为：

(offset, onoffseq),

在哪里？ 奥诺夫斯克 是以点为单位的偶数长度元组。有关示例，请参见 直线运动 .

披风 : str, default: rcParams["patch.capstyle"]str，默认值：

用于覆盖集合中所有路径的行的样式。看到了吗 连接样式和封口样式 对于每个允许值的演示。

连接方式 : str, default: rcParams["patch.joinstyle"]str，默认值：

用于连接集合中所有路径的线的样式。看到了吗 连接样式和封口样式 对于每个允许值的演示。

抗混叠剂 : bool or list of bool, default: rcParams["patch.antialiased"] (default: True)bool或bool列表，默认值：

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

offsets（float，float）或其列表，默认值：（0，0）

渲染后用于平移每个面片的向量（默认值为“无平移”）。在屏幕（像素）坐标中执行转换（即，在应用艺术家的变换之后）。

横向偏移 ： Transform ，默认值： IdentityTransform变换，默认值：IdentityTransform

将应用于每个 偏移量 使用前的向量。

offset_position{screen'（默认），'data'（已弃用）}

如果设置为“数据”（已弃用）， 偏移量 将被视为数据坐标而不是屏幕坐标。

norm ： Normalize 可选正常化，可选

转发至 ScalarMappable . 违约 None 意味着将设置第一个抽签调用 vmin 和 vmax 使用数据的最小值和最大值。

cmap ： Colormap 可选颜色映射，可选

转发至 ScalarMappable . 违约 None 将导致 rcParams["image.cmap"] (default: 'viridis') 正在使用。

hatch可选的STR

填充路径中使用的填充图案（如果有）。有效字符串为 ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*'] . 见 舱口演示 对于每个图案填充类型的含义。

pickradius浮动，默认值：5.0

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

urlsstr列表，默认：无

绘制后要链接到的每个修补程序的URL。目前只适用于SVG后端。看到了吗 超链接 举个例子。

zorder浮点，默认值：1

集合中所有面片共享的绘图顺序。看到了吗 Zorder演示 对于所有默认值和示例。

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths()

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

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

基类：matplotlib.collections.Collection

使用样条线绘制的椭圆集合。

参数:

widths类数组

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

heights类数组

第二个轴的长度。

angles类数组

第一个轴的角度，与X轴成反角。

units“点”、“英寸”、“点”、“宽度”、“高度”、“x”、“y”、“x y”

给出主次关系的单位；“宽度”和“高度”指的是轴的尺寸，“x”和“y”指的是 偏移量 数据单元。xy'与其他所有的不同之处在于，绘制的角度随展弦比的变化而变化，并且仅当展弦比为统一时才等于指定的角度。因此，它的行为与 Ellipse 具有 axes.transData 作为它的转变。

**kwargs

转发至 Collection .

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths()

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_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)

基类：matplotlib.collections.LineCollection

沿单个轴发生“事件”的位置集合。

事件由一维数组给出。它们没有振幅，显示为平行线。

参数:

positions一维阵列状

每个值都是一个事件。

orientation{'horizontal'，'vertical'}，默认值：'horizontal'

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

lineoffset浮点，默认值：0

标记中心相对于原点的偏移量，在垂直于 方向 .

linelength浮点，默认值：1

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

线宽 : float or list thereof, default: rcParams["lines.linewidth"] (default: 1.5)浮动或浮动列表，默认值：

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

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

事件行的颜色。

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

有效字符串是 ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':'] . 短划线元组的形式应为：

(offset, onoffseq),

在哪里？ 奥诺夫斯克 是一个偶数长度的开/关墨水点元组。

反锯齿 : bool or list thereof, default: rcParams["lines.antialiased"] (default: True)bool或其列表，默认值：

是否使用抗锯齿绘制直线。

**kwargs

转发至 LineCollection .

实例

(Source code _, png ， pdf ）

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

add_positions(position)

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

append_positions(position)

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

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

extend_positions(position)

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_color()

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

get_colors()

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linelength()

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

get_lineoffset()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

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

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_orientation()

返回事件行的方向（“水平”或“垂直”）。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_positions()

返回包含位置的浮点值的数组。

get_rasterized()

返回是否将艺术家栅格化。

get_segments()

返回:

列表

LineCollection中的段列表。每个列表项都包含一个顶点数组。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_horizontal()

如果eventcollection是水平的，则为True；如果是垂直的，则为False。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置LineCollection的颜色。

参数:

c颜色或颜色列表

单色（所有面片都有相同的颜色）或rgba元组序列；如果是序列，面片将在序列中循环。

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linelength(linelength)

设置用于标记每个事件的行的长度。

set_lineoffset(lineoffset)

设置用于标记每个事件的线的偏移量。

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_orientation(orientation=None)

设置事件线的方向。

参数:

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

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths(segments)

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_positions(positions)

设置事件的位置。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

set_segments(segments)

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_verts(segments)

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， 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 .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

class matplotlib.collections.LineCollection(segments, linewidths=None, colors=None, antialiaseds=None, linestyles='solid', offsets=None, transOffset=None, norm=None, cmap=None, pickradius=5, zorder=2, facecolors='none', **kwargs)

基类：matplotlib.collections.Collection

表示一系列 Line2D 我们应该把它们放在一起。

该类扩展 Collection 表示一系列的 Line2D 而不仅仅是一系列 Patch s、 就像在 Collection ，每个属性 LineCollection 可以是单个值或值列表。然后，此列表循环用于LineCollection的每个元素，因此 i 集合的第个元素是：

prop[i % len(prop)]

系统中每个成员的属性 LineCollection 默认为中的值 rcParams["lines.*"] 而不是 rcParams["patch.*"] ，以及财产 ** 添加以代替 绿色染料 .

参数:

segments: list of array-like

一系列 线0 ， 线1 ， 线2 ）：

linen = (x0, y0), (x1, y1), ... (xm, ym)

或具有两列的等效numpy数组。每条线可以有不同数量的线段。

线宽度 : float or list of float, default: rcParams["lines.linewidth"] (default: 1.5)浮动或浮动列表，默认值：

以点为单位的每行的宽度。

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

rgba元组的序列（例如，不允许使用任意颜色字符串等）。

抗混叠剂 : bool or list of bool, default: rcParams["lines.antialiased"] (default: True)bool或bool列表，默认值：

是否对每行使用抗锯齿。

zorderint，默认值：2

一次画线的顺序。

facecolors颜色或颜色列表，默认值：“无”

LineCollection的FaceColor。设置为“无”以外的值将导致每条线被“填充”，就好像有一条隐式线段将该线的最后和第一个点重新连接在一起一样。为了手动指定应计为每行“内部”的内容，请使用 PathCollection 相反，“内部”可以通过适当使用 CLOSEPOLY .

**kwargs

Forwared到 Collection .

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_color()

get_colors()

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_segments()

返回:

列表

LineCollection中的段列表。每个列表项都包含一个顶点数组。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置LineCollection的颜色。

参数:

c颜色或颜色列表

单色（所有面片都有相同的颜色）或rgba元组序列；如果是序列，面片将在序列中循环。

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths(segments)

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

set_segments(segments)

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_verts(segments)

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

class matplotlib.collections.PatchCollection(patches, match_original=False, **kwargs)

基类：matplotlib.collections.Collection

修补程序的一般集合。

这使得将颜色映射分配给各种各样的修补程序集合变得更容易。

这也可以提高打印速度，因为PatchCollection的绘制速度比大量的修补程序快。

补片

补丁对象的序列。此列表可能包括不同补丁类型的异构分类。

match_original

如果为真，请使用原始面片的颜色和线条宽度。如果为false，则可以通过提供标准集合参数、facecolor、edgecolor、线宽、norm或cmap来指定新颜色。

如果有 绿色染料 ， 脸色 ， 线宽度 ， 抗混叠剂 没有，他们默认 rcParams 补丁设置，顺序形式。

The use of ScalarMappable functionality is optional. If the ScalarMappable matrix _A has been set (via a call to set_array), at draw time a call to scalar mappable will be made to set the face colors.

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths(patches)

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

class matplotlib.collections.PathCollection(paths, sizes=None, **kwargs)

基类：matplotlib.collections._CollectionWithSizes

收藏 Path s、 例如。 scatter .

参数:

路径 名单 path.Path名单

将构成 Collection .

sizes类数组

按比例缩放每个图形的因子 Path . 路径数据空间中的一个平方单位被缩放为 sizes**2 渲染时的点。

**kwargs

转发至 Collection .

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_sizes()

返回集合中元素的大小（“区域”）。

返回:

数组

每个元素的“面积”。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

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

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

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

这对于获取 scatter 绘图；例如：

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

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

也看到 自动创建图例 例子。

参数:

prop{“colors”，“size”}，默认值：“colors”

如果是“颜色”，图例句柄将显示集合的不同颜色。如果是“尺寸”，图例将显示不同的尺寸。要设置两者，请使用 关键字参数 直接编辑 Line2D 性质。

num ：int、None、“auto”（默认）、类似数组或 Locator ，int、None、“auto”（默认）、类似数组或

要创建的目标元素数。如果没有，则使用可映射数组的所有唯一元素。如果是整数，则使用目标 num 标准范围内的元素。如果 “自动” ，尝试确定哪个选项更适合数据的性质。创建的元素数可能会稍微偏离 num 由于 Locator 用来寻找有用的地点。如果是一个列表或数组，请使用这些元素作为图例。最后，一个 Locator 可以提供。

fmt STR， Formatter ，或无（默认）结构，

用于标签的格式或格式化程序。如果字符串必须是 StrMethodFormatter . 如果没有（默认值），则使用 ScalarFormatter .

func 默认值：函数 λx:x功能，默认

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

**kwargs

允许的关键字参数是 颜色 和 size . E、 g.如果 prop="sizes" 使用；类似于设置标记的大小，如果 prop="colors" 被使用。任何进一步的参数都会传递到 Line2D 实例。这可能有助于指定不同的 标记彩色图像 或 阿尔法 用于图例手柄。

返回:

把手 名单 Line2D名单

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

labelsstr列表

图例元素的字符串标签。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths(paths)

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

set_sizes(sizes, dpi=72.0)

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

参数:

sizes无或无

要为集合的每个元素设置的大小。该值是元素的“区域”。

dpi浮动，默认值：72

画布的dpi。

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

class matplotlib.collections.PolyCollection(verts, sizes=None, closed=True, **kwargs)

基类：matplotlib.collections._CollectionWithSizes

参数:

verts类数组列表

多边形序列 [verts0, verts1, ...] 每个元素 verts_i 定义多边形的顶点 i 作为一个类似于形状（M，2）的二维数组。

sizes类似数组，默认值：无

多边形的平方缩放因子。每个多边形的坐标 verts_i 乘以中相应项的平方根 尺寸 （即， 尺寸 指定区域的缩放比例）。缩放在艺术家主变换之前应用。

closedbool，默认值：True

是否应该通过在末端添加CLOSEPOLY连接来闭合多边形。

**kwargs

转发至 Collection .

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_sizes()

返回集合中元素的大小（“区域”）。

返回:

数组

每个元素的“面积”。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths(verts, closed=True)

设置多边形的顶点。

参数:

verts类数组列表

多边形序列 [verts0, verts1, ...] 每个元素 verts_i 定义多边形的顶点 i 作为一个类似于形状（M，2）的二维数组。

closedbool，默认值：True

是否应该通过在末端添加CLOSEPOLY连接来闭合多边形。

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

set_sizes(sizes, dpi=72.0)

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

参数:

sizes无或无

要为集合的每个元素设置的大小。该值是元素的“区域”。

dpi浮动，默认值：72

画布的dpi。

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_verts(verts, closed=True)

设置多边形的顶点。

参数:

verts类数组列表

多边形序列 [verts0, verts1, ...] 每个元素 verts_i 定义多边形的顶点 i 作为一个类似于形状（M，2）的二维数组。

closedbool，默认值：True

是否应该通过在末端添加CLOSEPOLY连接来闭合多边形。

set_verts_and_codes(verts, codes)

使用路径代码初始化顶点。

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

class matplotlib.collections.QuadMesh(meshWidth, meshHeight, coordinates, antialiased=True, shading='flat', **kwargs)

基类：matplotlib.collections.Collection

用于有效绘制四边形网格的类。

四边形网格由顶点网格组成。这个数组的维数是（ 网格宽度 + 1， 网高 + 1）。网格中的每个顶点都有一组不同的“网格坐标”，表示其在网格拓扑中的位置。对于任何值（ m ， n ）这样0<= m <= 网格宽度 0 < n <= 网高 ，网格坐标处的顶点（ m ， n ） m ， n + 1） m + 1， n + 1）和（ m + 1， n ）在网格中形成一个四边形。因此（ 网格宽度 * * 网格高度*）网格中的四边形。网格不需要是规则的，多边形也不需要是凸的。

四边形网格由（2 x）表示（（ 网格宽度 + 1） * (* 网高 +1）））numpy数组 协调 ，每行是 X 和 其中一个顶点的y*坐标。要定义从数据点映射到其相应颜色的函数，请使用 set_cmap() 方法。这些数组中的每一个都按行主顺序由顶点的网格坐标（或左下顶点的网格坐标，如果是颜色）编制索引。

例如，在 协调 是网格坐标（0，0）处顶点的坐标，然后是（0，1）处顶点的坐标，然后是（0，2）处顶点的坐标。（0，网格宽度），（1，0），（1，1）等等。

阴影 可能是“平的”，也可能是“古鲁德”

参数:

绿色染料 : color or list of colors, default: rcParams["patch.edgecolor"] (default: 'black')颜色或颜色列表，默认值：

构成集合的每个补丁的边缘颜色。可以传递特殊值“face”，使edgecolor与facecolor匹配。

脸色 : color or list of colors, default: rcParams["patch.facecolor"] (default: 'C0')颜色或颜色列表，默认值：

构成系列的每个贴片的面部颜色。

线宽度 : float or list of floats, default: rcParams["patch.linewidth"] (default: 1.0)浮动或浮动列表，默认值：

组成集合的每个面片的线宽。

linestylesstr或tuple或其列表，默认值：“solid”

有效字符串是 ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':'] . 短划线元组的形式应为：

(offset, onoffseq),

在哪里？ 奥诺夫斯克 是以点为单位的偶数长度元组。有关示例，请参见 直线运动 .

披风 : str, default: rcParams["patch.capstyle"]str，默认值：

用于覆盖集合中所有路径的行的样式。看到了吗 连接样式和封口样式 对于每个允许值的演示。

连接方式 : str, default: rcParams["patch.joinstyle"]str，默认值：

用于连接集合中所有路径的线的样式。看到了吗 连接样式和封口样式 对于每个允许值的演示。

抗混叠剂 : bool or list of bool, default: rcParams["patch.antialiased"] (default: True)bool或bool列表，默认值：

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

offsets（float，float）或其列表，默认值：（0，0）

渲染后用于平移每个面片的向量（默认值为“无平移”）。在屏幕（像素）坐标中执行转换（即，在应用艺术家的变换之后）。

横向偏移 ： Transform ，默认值： IdentityTransform变换，默认值：IdentityTransform

将应用于每个 偏移量 使用前的向量。

offset_position{screen'（默认），'data'（已弃用）}

如果设置为“数据”（已弃用）， 偏移量 将被视为数据坐标而不是屏幕坐标。

norm ： Normalize 可选正常化，可选

转发至 ScalarMappable . 违约 None 意味着将设置第一个抽签调用 vmin 和 vmax 使用数据的最小值和最大值。

cmap ： Colormap 可选颜色映射，可选

转发至 ScalarMappable . 违约 None 将导致 rcParams["image.cmap"] (default: 'viridis') 正在使用。

hatch可选的STR

填充路径中使用的填充图案（如果有）。有效字符串为 ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*'] . 见 舱口演示 对于每个图案填充类型的含义。

pickradius浮动，默认值：5.0

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

urlsstr列表，默认：无

绘制后要链接到的每个修补程序的URL。目前只适用于SVG后端。看到了吗 超链接 举个例子。

zorder浮点，默认值：1

集合中所有面片共享的绘图顺序。看到了吗 Zorder演示 对于所有默认值和示例。

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

static convert_mesh_to_paths(meshWidth, meshHeight, coordinates)

将给定网格转换为一系列 Path 物体。

此函数主要用于不直接支持四边形网格的后端实现者。

convert_mesh_to_triangles(meshWidth, meshHeight, coordinates)

将给定的网格转换为一系列三角形，每个点都有自己的颜色。这对于使用 draw_gouraud_triangle .

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths()

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

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

基类：matplotlib.collections._CollectionWithSizes

n边正多边形的集合。

参数:

numsides利息

多边形的边数。

rotation浮动

多边形以弧度为单位的旋转。

sizes浮点元组

在点^2中包围多边形的圆的面积。

**kwargs

转发至 Collection .

实例

见 套索演示 举个完整的例子：

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,
    transOffset=ax.transData,
    )

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_numsides()

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_rotation()

get_sizes()

返回集合中元素的大小（“区域”）。

返回:

数组

每个元素的“面积”。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths()

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

set_sizes(sizes, dpi=72.0)

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

参数:

sizes无或无

要为集合的每个元素设置的大小。该值是元素的“区域”。

dpi浮动，默认值：72

画布的dpi。

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

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

基类：matplotlib.collections.RegularPolyCollection

用 纽曼斯 点。

参数:

numsides利息

多边形的边数。

rotation浮动

多边形以弧度为单位的旋转。

sizes浮点元组

在点^2中包围多边形的圆的面积。

**kwargs

转发至 Collection .

实例

见 套索演示 举个完整的例子：

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,
    transOffset=ax.transData,
    )

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_numsides()

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_rotation()

get_sizes()

返回集合中元素的大小（“区域”）。

返回:

数组

每个元素的“面积”。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths()

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

set_sizes(sizes, dpi=72.0)

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

参数:

sizes无或无

要为集合的每个元素设置的大小。该值是元素的“区域”。

dpi浮动，默认值：72

画布的dpi。

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0

class matplotlib.collections.TriMesh(triangulation, **kwargs)

基类：matplotlib.collections.Collection

类，用于使用Gouraud着色高效绘制三角形网格。

三角形网格是 Triangulation 对象。

参数:

绿色染料 : color or list of colors, default: rcParams["patch.edgecolor"] (default: 'black')颜色或颜色列表，默认值：

构成集合的每个补丁的边缘颜色。可以传递特殊值“face”，使edgecolor与facecolor匹配。

脸色 : color or list of colors, default: rcParams["patch.facecolor"] (default: 'C0')颜色或颜色列表，默认值：

构成系列的每个贴片的面部颜色。

线宽度 : float or list of floats, default: rcParams["patch.linewidth"] (default: 1.0)浮动或浮动列表，默认值：

组成集合的每个面片的线宽。

linestylesstr或tuple或其列表，默认值：“solid”

有效字符串是 ['solid', 'dashed', 'dashdot', 'dotted', '-', '--', '-.', ':'] . 短划线元组的形式应为：

(offset, onoffseq),

在哪里？ 奥诺夫斯克 是以点为单位的偶数长度元组。有关示例，请参见 直线运动 .

披风 : str, default: rcParams["patch.capstyle"]str，默认值：

用于覆盖集合中所有路径的行的样式。看到了吗 连接样式和封口样式 对于每个允许值的演示。

连接方式 : str, default: rcParams["patch.joinstyle"]str，默认值：

用于连接集合中所有路径的线的样式。看到了吗 连接样式和封口样式 对于每个允许值的演示。

抗混叠剂 : bool or list of bool, default: rcParams["patch.antialiased"] (default: True)bool或bool列表，默认值：

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

offsets（float，float）或其列表，默认值：（0，0）

渲染后用于平移每个面片的向量（默认值为“无平移”）。在屏幕（像素）坐标中执行转换（即，在应用艺术家的变换之后）。

横向偏移 ： Transform ，默认值： IdentityTransform变换，默认值：IdentityTransform

将应用于每个 偏移量 使用前的向量。

offset_position{screen'（默认），'data'（已弃用）}

如果设置为“数据”（已弃用）， 偏移量 将被视为数据坐标而不是屏幕坐标。

norm ： Normalize 可选正常化，可选

转发至 ScalarMappable . 违约 None 意味着将设置第一个抽签调用 vmin 和 vmax 使用数据的最小值和最大值。

cmap ： Colormap 可选颜色映射，可选

转发至 ScalarMappable . 违约 None 将导致 rcParams["image.cmap"] (default: 'viridis') 正在使用。

hatch可选的STR

填充路径中使用的填充图案（如果有）。有效字符串为 ['/', '', '|', '-', '+', 'x', 'o', 'O', '.', '*'] . 见 舱口演示 对于每个图案填充类型的含义。

pickradius浮动，默认值：5.0

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

urlsstr列表，默认：无

绘制后要链接到的每个修补程序的URL。目前只适用于SVG后端。看到了吗 超链接 举个例子。

zorder浮点，默认值：1

集合中所有面片共享的绘图顺序。看到了吗 Zorder演示 对于所有默认值和示例。

add_callback(func)

添加一个回调函数，当 Artist 的属性更改。

参数:

func可赎回的

回调函数。必须有签名：

def func(artist: Artist) -> Any

在哪里？ 艺术家 是主叫吗 Artist . 返回值可能存在，但会被忽略。

返回:

利息

与回调关联的观察者id。此id可用于删除带有 remove_callback 后来。

参见

remove_callback

add_checker(checker)

[Deprecated]

笔记

3.3 版后已移除:

autoscale()

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

autoscale_None()

使用当前数组自动缩放Norm实例上的标量限制，只更改非的限制

property axes

这个 Axes 艺术家居住的实例，或 None .

changed()

每当mappable被更改时调用此函数，以将“changed”信号通知所有callbackSM侦听器。

check_update(checker)

[Deprecated]

笔记

3.3 版后已移除:

contains(mouseevent)

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

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

static convert_mesh_to_paths(tri)

将给定网格转换为一系列 Path 物体。

此函数主要用于不直接支持网格的后端实现者。

convert_xunits(x)

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

如果艺术家不包含在轴中，或者如果X轴没有单位， x 返回自身。

convert_yunits(y)

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

如果艺术家不包含在一个轴中，或者如果亚轴没有单位， y 返回自身。

draw(renderer)

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

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

参数:

渲染器 ： RendererBase 子类。RenderBase子类。

笔记

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

findobj(match=None, include_self=True)

查找艺术家对象。

递归查找全部 Artist 艺术家中包含的实例。

参数:

match

匹配项的筛选条件。这可能是

• None ：返回艺术家中包含的所有对象。
• 有签名的函数 def match(artist: Artist) -> bool . 结果将只包含函数返回的艺术家 True .
• 类实例：例如。， Line2D . 结果将只包含此类或其子类的艺术家 (isinstance 检查）。

include_self布尔

包括 self 在要检查匹配项的列表中。

返回:

名单 Artist

format_cursor_data(data)

返回的字符串表示形式 data .

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

默认实现将int和float以及int和float数组转换为括在方括号中的逗号分隔字符串。

参见

get_cursor_data

get_agg_filter()

返回用于agg筛选器的筛选器函数。

get_alpha()

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

get_animated()

返回艺术家是否已设置动画。

get_array()

返回数据数组。

get_capstyle()

get_children()

返回孩子的列表 Artist 这是什么 Artist .

get_clim()

返回映射到colormap限制的值（最小值、最大值）。

get_clip_box()

归还剪贴簿。

get_clip_on()

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

get_clip_path()

返回剪辑路径。

get_cmap()

返回 Colormap 实例。

get_contains()

[Deprecated] 返回艺术家的自定义包含函数（如果设置），或 None .

参见

set_contains

笔记

3.3 版后已移除.

get_cursor_data(event)

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

注解

此方法将被artist子类重写。作为Matplotlib的最终用户，您很可能不会自己调用此方法。

艺术家可以使用光标数据为给定事件提供附加的上下文信息。默认实现只返回 None .

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

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

参数:

事件 ： matplotlib.backend_bases.MouseEventmatplotlib.backend_bases.MouseEvent

参见

format_cursor_data

get_dashes()

Alias get_linestyle .

get_datalim(transData)

get_ec()

Alias get_edgecolor .

get_edgecolor()

get_edgecolors()

Alias get_edgecolor .

get_facecolor()

get_facecolors()

Alias get_facecolor .

get_fc()

Alias get_facecolor .

get_figure()

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

get_fill()

返回是否已设置填充。

get_gid()

返回组id。

get_hatch()

返回当前图案填充图案。

get_in_layout()

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

例如。 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

get_joinstyle()

get_label()

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

get_linestyle()

get_linestyles()

Alias get_linestyle .

get_linewidth()

get_linewidths()

Alias get_linewidth .

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_offset_position()

[Deprecated] 返回如何为集合应用偏移量。如果 offset_position 是“screen”，应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

笔记

3.3 版后已移除.

get_offset_transform()

get_offsets()

返回集合的偏移量。

get_path_effects()

get_paths()

get_picker()

返回艺术家的拾取行为。

中描述了可能的值 set_picker .

参见

set_picker, pickable, pick

get_pickradius()

get_rasterized()

返回是否将艺术家栅格化。

get_sketch_params()

返回艺术家的草图参数。

返回:

元组或无

包含以下元素的3元组：

• 规模 ：垂直于震源线的摆动幅度。
• 长度 ：沿线路摆动的长度。
• 随机性 ：缩小或扩展长度的比例因子。

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

get_snap()

返回捕捉设置。

见 set_snap 有关详细信息。

get_tightbbox(renderer)

喜欢 Artist.get_window_extent ，但包括任何剪辑。

参数:

渲染器 ： RendererBase 子类RenderBase子类

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

返回:

Bbox

封闭边界框（以图形像素坐标表示）。

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)

获取显示空间中的轴边界框。

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

子类应重写以包含在边界框“紧”计算中。默认值是返回0，0处的空边界框。

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

get_zorder()

返回艺术家的zorder。

have_units()

返回 True 如果在任何轴上设置了单位。

is_transform_set()

返回艺术家是否具有显式设置的变换。

这是 True 之后 set_transform 已被调用。

property mouseover

如果此属性设置为 True ，则当鼠标光标移动到艺术家身上时，将查询该艺术家的自定义上下文信息。

也见 get_cursor_data() ， ToolCursorPosition 和 NavigationToolbar2 .

pchanged()

调用所有已注册的回调。

此函数在属性更改时在内部触发。

参见

add_callback

remove_callback

pick(mouseevent)

处理pick事件。

每个儿童艺术家将触发一个选择事件，如果 鼠标移动 在艺术家和艺术家有选择集。

参见

set_picker, get_picker, pickable

pickable()

返回艺术家是否可选择。

参见

set_picker, get_picker, pick

properties()

返回艺术家所有属性的词典。

remove()

如果可能的话，将艺术家从人物中移除。

在重新绘制图形之前，效果将不可见，例如，使用 FigureCanvasBase.draw_idle . 呼叫 relim 如果需要，更新轴限制。

注： relim 即使集合已添加到轴，也不会看到集合 自动着陆系统 =真。

注意：不支持删除艺术家的图例项。

remove_callback(oid)

根据观察者id移除回调。

参见

add_callback

set(**kwargs)

属性批处理设置程序。通过 关键字参数 设置属性。

set_aa(aa)

Alias set_antialiased .

set_agg_filter(filter_func)

设置agg过滤器。

参数:

filter_func可赎回的

一种过滤函数，它接受一个（m，n，3）浮点数组和一个dpi值，并返回一个（m，n，3）数组。

set_alpha(alpha)

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

参数:

alpha浮动或无

set_animated(b)

设置艺术家的动画状态。

参数:

b布尔

set_antialiased(aa)

设置渲染的抗锯齿状态。

参数:

aa布尔或布尔列表

set_antialiaseds(aa)

Alias set_antialiased .

set_array(A)

从numpy数组设置图像数组 A .

参数:

A恩达雷

set_capstyle(cs)

设置集合的capstyle（针对其所有元素）。

参数:

cs“对接”、“圆形”、“突出”

capstyle。

set_clim(vmin=None, vmax=None)

设置图像缩放的标准限制。

参数:

VMN，Vmax浮动

极限。

这些限制也可以作为元组传递( vmin ， vmax )作为一个位置参数。

set_clip_box(clipbox)

设置艺术家的剪辑 Bbox .

参数:

剪贴盒 ： Bbox盒子

set_clip_on(b)

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

当虚假的艺术家将可见的轴以外，这可能会导致意想不到的结果。

参数:

b布尔

set_clip_path(path, transform=None)

设置艺术家的剪辑路径。

参数:

path ： Patch 或 Path 或 TransformedPath 或无修补程序或路径或转换路径或无

剪辑路径。如果给予 Path ， 转型 也必须提供。如果 None ，将删除先前设置的剪辑路径。

转型 ： Transform 可选变换，可选

仅在以下情况下使用 path 是一个 Path ，在这种情况下 Path 转换为 TransformedPath 使用 转型 .

笔记

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

出于技术原因（支持 set )，一个元组( path ， 转型 )也可作为单个位置参数接受。

set_cmap(cmap)

设置亮度数据的颜色贴图。

参数:

cmap ： Colormap 或str或NoneColormap或str或None

set_color(c)

设置EdgeColor和FaceColor。

参数:

crgba元组的颜色或列表

参见

Collection.set_facecolor, Collection.set_edgecolor

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

set_contains(picker)

[Deprecated] 为艺术家定义自定义包含测试。

提供的callable替换默认值 contains 艺术家的方法。

参数:

picker可赎回的

用于评估事件是否在艺术家内部的自定义选取器函数。函数必须具有签名：

def contains(artist: Artist, event: MouseEvent) -> bool, dict

返回：

• 指示事件是否在艺术家内部的布尔值
• 附加信息的口述。dict至少应该返回与默认值相同的信息 contains() 实现各自的艺术家，但可以提供额外的信息。

笔记

3.3 版后已移除.

set_dashes(ls)

Alias set_linestyle .

set_ec(c)

Alias set_edgecolor .

set_edgecolor(c)

设置集合的EdgeColor。

参数:

c颜色或颜色列表或“面”

edgecolor系列。如果是一个序列，补丁会循环通过它。如果是“face”，则与facecolor匹配。

set_edgecolors(c)

Alias set_edgecolor .

set_facecolor(c)

设置集合的facecolor。 c 可以是一种颜色（所有面片都有相同的颜色），也可以是一系列颜色；如果是一个序列，则面片将在序列中循环。

如果 c 为“无”，将不填充修补程序。

参数:

c颜色或颜色列表

set_facecolors(c)

Alias set_facecolor .

set_fc(c)

Alias set_facecolor .

set_figure(fig)

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

参数:

fig ： Figure图形

set_gid(gid)

设置艺术家的（组）id。

参数:

gidSTR

set_hatch(hatch)

设置图案填充图案

孵化 可以是：

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

字母可以组合，在这种情况下，所有指定的阴影都会完成。如果相同的字母重复，它会增加该图案阴影的密度。

只有PostScript、PDF、SVG和AGG后端支持图案填充。

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

参数:

孵化 ：{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'''、''、'*'}'/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'

set_in_layout(in_layout)

设置是否将艺术家包括在布局计算中，例如 受约束的布局参考线 ， Figure.tight_layout() 和 fig.savefig(fname, bbox_inches='tight') .

参数:

in_layout布尔

set_joinstyle(js)

设置集合的joinstyle（对于它的所有元素）。

参数:

js'miter'、'round'、'bevel'

joinstyle。

set_label(s)

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

参数:

s对象

s 将通过调用 str .

set_linestyle(ls)

设置集合的线条样式。

线型	描述
'-' or 'solid'	实线
'--' or 'dashed'	虚线
'-.' or 'dashdot'	虚线
':' or 'dotted'	虚线

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

(offset, onoffseq),

在哪里？ onoffseq 是一个偶数长度的开/关墨水点元组。

参数:

lsstr或tuple或其列表

Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description.

set_linestyles(ls)

Alias set_linestyle .

set_linewidth(lw)

设置集合的线条宽度。 lw 可以是标量或序列；如果是序列，补丁将在序列中循环

参数:

lw浮动或浮动列表

set_linewidths(lw)

Alias set_linewidth .

set_ls(ls)

Alias set_linestyle .

set_lw(lw)

Alias set_linewidth .

set_norm(norm)

设置规范化实例。

参数:

norm ： Normalize 或无正常化或无

笔记

如果有任何colorbar使用此规范的可映射，则设置可映射的规范会将colorbar上的norm、locator和formatters重置为默认值。

set_offset_position(offset_position)

[Deprecated] 设置偏移的应用方式。如果 offset_position 是“screen”（默认值），应用主转换后应用偏移量，即偏移量在屏幕坐标中。如果偏移位置为“数据”，则在主转换之前应用偏移，即偏移位于数据坐标中。

参数:

offset_position'screen'、'data'

笔记

3.3 版后已移除.

set_offsets(offsets)

设置集合的偏移量。

参数:

offsets类似于（N，2）或（2，）

set_path_effects(path_effects)

设置路径效果。

参数:

path_effects ： AbstractPathEffectAbstractPathEffect

set_paths()

set_picker(picker)

定义艺术家的采摘行为。

参数:

picker无、布尔或可呼叫

这可以是以下情况之一：

• None ：此艺术家禁用拾取（默认）。

• 布尔值：如果 True 然后将启用拾取，并且如果鼠标事件位于艺术家上方，艺术家将触发拾取事件。

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

  hit, props = picker(artist, mouseevent)
  

  以确定命中测试。如果鼠标事件在艺术家上方，则返回 hit=True props是一个你想要添加到pickevent属性的属性字典。

• 贬低 为了 Line2D 只是， 捡拾器 也可以是一个float，用于设置检查事件是否“在”行上发生的容差；这是不推荐使用的。使用 Line2D.set_pickradius 相反。

set_pickradius(pr)

设置用于安全壳测试的拾取半径。

参数:

d浮动

拾取半径，以点为单位。

set_rasterized(rasterized)

在矢量后端输出中强制栅格化（位图）绘图。

默认为无，这意味着后端的默认行为。

参数:

rasterized布尔或无

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

设置草图参数。

参数:

scale可选浮动

垂直于震源线的摆动幅度，以像素为单位。如果规模是 None 或未提供，将不提供草图过滤器。

length可选浮动

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

randomness可选浮动

缩小或展开长度的比例因子（默认值为16.0）

set_snap(snap)

设置捕捉行为。

捕捉将位置与像素网格对齐，这样可以获得更清晰的图像。例如，如果在两个像素之间的位置定义了1px宽度的黑线，则生成的图像将包含像素网格中该线的插值值，该值将是两个相邻像素位置上的灰度值。相反，捕捉会将线条移动到最接近的整数像素值，因此生成的图像将真正包含1px宽的黑线。

快照当前仅由Agg和MacOSX后端支持。

参数:

snap布尔或无

可能值：

• True ：将顶点捕捉到最近的像素中心。
• 假 ：不要修改顶点位置。
• None ：（自动）如果路径只包含直线线段，则舍入到最近的像素中心。

set_transform(t)

设置艺术家变换。

参数:

t ： Transform变换

set_url(url)

设置艺术家的url。

参数:

urlSTR

set_urls(urls)

参数:

urlsstr或None列表

笔记

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

set_visible(b)

设置艺术家的可见性。

参数:

b布尔

set_zorder(level)

为艺术家设置Zorder。先绘制具有较低zorder值的艺术家。

参数:

level浮动

property stale

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

property sticky_edges

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

执行自动缩放时，如果数据限制与相应的粘滞边缘列表中的值一致，则不会添加任何边距--视图限制“粘住”到边缘。一个典型的用例是直方图，在这种情况下，人们通常期望直方图的下边缘（0）没有边距。

无法将此属性分配给；但是， x 和 y 可以根据需要就地修改列表。

实例

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

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

返回对应于 x .

在正常情况下， x 是一个一维或二维的scalar序列，将根据此scalarmapable的norm和colormap集返回相应的rgba值的ndarray。

有一种特殊情况，用于处理已经是rgb或rgba的图像，例如从图像文件读取的图像。如果 x 是一个具有3个维度的ndarray，最后一个维度是3或4，那么它将被视为一个rgb或rgba数组，并且不会进行任何映射。数组可以是uint8，也可以是值在0-1范围内的浮点；否则将引发valueerror。如果是屏蔽数组，则将忽略该屏蔽。如果最后一个维度是3，则 阿尔法 Kwarg（默认为1）将用于填写透明度。如果最后一个维度是4，则 阿尔法 Kwarg被忽略；它不会取代现有的alpha。如果第三个维度不是3或4，则会引发ValueError。

无论哪种情况，如果 字节 是 假 （默认），rgba数组将在0-1范围内浮动；如果是 True ，返回的rgba数组将在0到255范围内为uint8。

如果norm为false，则不执行输入数据的规范化，并假定它在范围（0-1）内。

update(props)

从dict更新此艺术家的属性 道具 .

参数:

props双关语

property update_dict

update_from(other)

将属性从其他复制到自身。

update_scalarmappable()

从标量可映射数组更新颜色（如果不是“无”）。

zorder = 0