matplotlib.patches.Patch

class matplotlib.patches.Patch(edgecolor=None, facecolor=None, color=None, linewidth=None, linestyle=None, antialiased=None, hatch=None, fill=True, capstyle=None, joinstyle=None, **kwargs)[源代码]

基类:matplotlib.artist.Artist

一个补丁是一个二维艺术家的脸颜色和边缘颜色。

如果有 变色染料脸色线宽反锯齿None ,它们默认为其rc-params设置。

支持以下Kwarg属性

财产 描述
agg_filter 一种过滤函数,它接受一个(m,n,3)浮点数组和一个dpi值,并返回一个(m,n,3)数组。
alpha 浮动或无
animated 布尔
antialiased 或者aa 未知的
capstyle “对接”、“圆形”、“突出”
clip_box Bbox
clip_on 布尔
clip_path 面片或(路径、变换)或无
color 颜色
contains 未知的
edgecolor 或ec 颜色或无或“自动”
facecolor 或fc 颜色或无
figure Figure
fill 布尔
gid STR
hatch '/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'
in_layout 布尔
joinstyle 'miter'、'round'、'bevel'
label 对象
linestyle 或ls '-'、'-'、'-'、'-'、':'、'、'、'(偏移量、开/关顺序)、…
linewidth 或lw 浮动或无
path_effects AbstractPathEffect
picker 无、布尔或可呼叫
rasterized 布尔或无
sketch_params (比例:浮动,长度:浮动,随机性:浮动)
snap 布尔或无
transform Transform
url STR
visible 布尔
zorder 浮动
__init__(edgecolor=None, facecolor=None, color=None, linewidth=None, linestyle=None, antialiased=None, hatch=None, fill=True, capstyle=None, joinstyle=None, **kwargs)[源代码]

支持以下Kwarg属性

财产 描述
agg_filter 一种过滤函数,它接受一个(m,n,3)浮点数组和一个dpi值,并返回一个(m,n,3)数组。
alpha 浮动或无
animated 布尔
antialiased 或者aa 未知的
capstyle “对接”、“圆形”、“突出”
clip_box Bbox
clip_on 布尔
clip_path 面片或(路径、变换)或无
color 颜色
contains 未知的
edgecolor 或ec 颜色或无或“自动”
facecolor 或fc 颜色或无
figure Figure
fill 布尔
gid STR
hatch '/'、''、''、'-'、'+'、'X'、'O'、'O'、'、'、'*'
in_layout 布尔
joinstyle 'miter'、'round'、'bevel'
label 对象
linestyle 或ls '-'、'-'、'-'、'-'、':'、'、'、'(偏移量、开/关顺序)、…
linewidth 或lw 浮动或无
path_effects AbstractPathEffect
picker 无、布尔或可呼叫
rasterized 布尔或无
sketch_params (比例:浮动,长度:浮动,随机性:浮动)
snap 布尔或无
transform Transform
url STR
visible 布尔
zorder 浮动
__module__ = 'matplotlib.patches'
contains(mouseevent, radius=None)[源代码]

测试修补程序中是否发生鼠标事件。

返回:
(布尔,空字典)
contains_point(point, radius=None)[源代码]

返回给定点是否在修补程序内。

参数:
point(浮标,浮标)

要检查的点(x,y),以目标坐标表示 self.get_transform() . 这些是添加到图形或轴上的面片的显示坐标。

radius可选浮动

在面片的目标坐标上添加一个额外的边距 self.get_transform() . 见 Path.contains_point 更多详情。

返回:
布尔

笔记

这种方法的正确使用取决于贴片的变换。孤立的面片没有变换。在这种情况下,面片创建坐标和点坐标匹配。以下示例检查圆的中心是否在圆内

>>> center = 0, 0
>>> c = Circle(center, radius=1)
>>> c.contains_point(center)
True

检查转换后的补丁的惯例源于这样一个事实:这种方法主要用于检查显示坐标(例如鼠标事件)是否在补丁内。如果要使用数据坐标进行上述检查,必须首先正确转换它们:

>>> center = 0, 0
>>> c = Circle(center, radius=1)
>>> plt.gca().add_patch(c)
>>> transformed_center = c.get_transform().transform(center)
>>> c.contains_point(transformed_center)
True
contains_points(points, radius=None)[源代码]

返回给定点是否在补丁内。

参数:
points(N,2)阵列

要检查的点,在目标坐标中 self.get_transform() . 这些是添加到图形或轴上的面片的显示坐标。列包含x和y值。

radius可选浮动

在面片的目标坐标上添加一个额外的边距 self.get_transform() . 见 Path.contains_point 更多详情。

返回:
长度N布尔数组

笔记

这种方法的正确使用取决于贴片的变换。参见上的注释 Patch.contains_point .

draw(renderer)[源代码]

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

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

参数:
渲染器RendererBase 子类。RenderBase子类。

笔记

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

property fill

返回补丁是否已填充。

get_aa()

Alias get_antialiased .

get_antialiased()[源代码]

返回是否将抗锯齿用于绘图。

get_capstyle()[源代码]

返回capstyle。

get_data_transform()[源代码]

返回 Transform 将数据坐标映射到物理坐标。

get_ec()

Alias get_edgecolor .

get_edgecolor()[源代码]

返回边颜色。

get_extents()[源代码]

返回 Patch 的轴对齐范围作为 Bbox .

get_facecolor()[源代码]

返回脸部颜色。

get_fc()

Alias get_facecolor .

get_fill()[源代码]

返回补丁是否已填充。

get_hatch()[源代码]

返回填充图案。

get_joinstyle()[源代码]

返回joinstyle。

get_linestyle()[源代码]

返回线条样式。

get_linewidth()[源代码]

返回以点为单位的线条宽度。

get_ls()

Alias get_linestyle .

get_lw()

Alias get_linewidth .

get_patch_transform()[源代码]

返回 Transform 实例将面片坐标映射到数据坐标。

例如,可以通过为单位圆提供坐标来定义表示半径为5的圆的面片,以及将坐标(面片坐标)缩放5的变换。

get_path()[源代码]

返回此修补程序的路径。

get_transform()[源代码]

返回 Transform 应用于 Patch .

get_verts()[源代码]

返回此面片中使用的顶点的副本。

如果面片包含贝塞尔曲线,则曲线将由线段插值。要将曲线作为曲线访问,请使用 get_path .

get_window_extent(renderer=None)[源代码]

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

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

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

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

set_aa(aa)

Alias set_antialiased .

set_alpha(alpha)[源代码]

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

参数:
alpha浮动或无
set_antialiased(aa)[源代码]

设置是否使用抗锯齿渲染。

参数:
b布尔或无
set_capstyle(s)[源代码]

设置capstyle。

参数:
s“对接”、“圆形”、“突出”
set_color(c)[源代码]

设置EdgeColor和FaceColor。

参数:
c颜色

参见

Patch.set_facecolor, Patch.set_edgecolor
用于单独设置边缘或面颜色。
set_ec(color)

Alias set_edgecolor .

set_edgecolor(color)[源代码]

设置面片边缘颜色。

参数:
color颜色或无或“自动”
set_facecolor(color)[源代码]

设置面片颜色。

参数:
color颜色或无
set_fc(color)

Alias set_facecolor .

set_fill(b)[源代码]

设置是否填充补丁。

参数:
b布尔
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_joinstyle(s)[源代码]

设置joinstyle。

参数:
s'miter'、'round'、'bevel'
set_linestyle(ls)[源代码]

设置修补线样式。

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

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

(offset, onoffseq)

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

参数:
ls'-'、'-'、'-'、'-'、':'、'、'、'(偏移量、开/关顺序)、…

线条风格。

set_linewidth(w)[源代码]

以点为单位设置面片线宽。

参数:
w浮动或无
set_ls(ls)

Alias set_linestyle .

set_lw(w)

Alias set_linewidth .

update_from(other)[源代码]

从复制属性 其他self .

validCap = ('butt', 'round', 'projecting')
validJoin = ('miter', 'round', 'bevel')
zorder = 1

使用实例 matplotlib.patches.Patch