matplotlib.patheffects

定义路径效果的类。Text和 支持路径Line2D效果Patch。

也可以看看

路径效果指南

类 matplotlib.patheffects。AbstractPathEffect ( offset = (0.0, 0.0) )

基地：object

路径效果的基类。

子类应覆盖该draw_path方法以添加效果功能。

参数：

偏移量（浮点数，浮点数），默认值：(0, 0)

应用于路径的 (x, y) 偏移量，以点为单位。

draw_path ( renderer , gc , tpath , affine , rgbFace = None )

Derived 应覆盖此方法。matplotlib.backend_bases.RendererBase.draw_path() 除了第一个参数是渲染器外，参数相同。

类 matplotlib.patheffects。正常( offset = (0.0, 0.0) )

基地：AbstractPathEffect

“身份” PathEffect。

Normal PathEffect 的唯一目的是绘制没有特殊路径效果的原始艺术家。

参数：

偏移量（浮点数，浮点数），默认值：(0, 0)

应用于路径的 (x, y) 偏移量，以点为单位。

类 matplotlib.patheffects。PathEffectRenderer ( path_effects , renderer )

基地：RendererBase

实现一个包含另一个渲染器的渲染器。

这个代理然后拦截绘图调用，调用适当的 AbstractPathEffect绘图方法。

笔记

并非所有方法都已在此 RendererBase 子类上被覆盖。可能需要添加更多方法来进一步扩展 PathEffects 功能。

参数：

path_effects可迭代的AbstractPathEffect

此渲染器表示的路径效果。

渲染器matplotlib.backend_bases.RendererBase子类

copy_with_path_effect ( path_effects )

draw_markers ( gc , marker_path , marker_trans , path , * args , ** kwargs )

在每个path的顶点（不包括控制点）绘制一个标记。

基本（后备）实现多次调用draw_path. 后端可能希望覆盖此方法，以便仅绘制一次标记并多次重复使用它。

参数：

GCGraphicsContextBase

图形上下文。

marker_transmatplotlib.transforms.Transform

应用于标记的仿射变换。

反式matplotlib.transforms.Transform

应用于路径的仿射变换。

draw_path ( gc , tpath , affine , rgbFace = None )

Path使用给定的仿射变换绘制一个实例。

draw_path_collection ( gc , master_transform , paths , * args , ** kwargs )

绘制路径集合。

每个路径首先由 all_transforms （(3, 3) 矩阵的列表）中的相应条目转换，然后由 master_transform 转换。然后它们由offsets中的相应条目转换，该条目首先由offset_trans转换。

facecolors、edgecolors、linewidths、linestyles和 antialiased是设置相应属性的列表。

offset_position现在未使用，但保留该参数是为了向后兼容。

基本（后备）实现多次调用draw_path. 后端可能希望覆盖它，以便只渲染每组路径数据一次，然后使用不同的偏移量、颜色、样式等多次引用该路径。生成器方法 _iter_collection_raw_paths和_iter_collection用于帮助（和标准化）实现跨后端。强烈建议使用这些生成器，以便draw_path_collection可以全局更改 的行为。

类 matplotlib.patheffects。PathPatchEffect ( offset = (0, 0) , ** kwargs )

基地：AbstractPathEffect

绘制一个PathPatch实例，其路径来自原始 PathEffect 艺术家。

参数：

偏移量（浮点数，浮点数），默认值：(0, 0)

应用于路径的 (x, y) 偏移量，以点为单位。

**kwargs

所有关键字参数都传递给 PathPatch构造函数。不能被覆盖的属性是“path”、“clip_box”、“transform”和“clip_path”。

draw_path ( renderer , gc , tpath , affine , rgbFace )

Derived 应覆盖此方法。matplotlib.backend_bases.RendererBase.draw_path() 除了第一个参数是渲染器外，参数相同。

类 matplotlib.patheffects。SimpleLineShadow ( offset = (2, -2) , shadow_color = 'k' , alpha = 0.3 , rho = 0.3 , ** kwargs )

基地：AbstractPathEffect

通过一条线的简单阴影。

参数：

偏移量（浮点数，浮点数），默认值：(2, -2)

应用于路径的 (x, y) 偏移量，以点为单位。

shadow_color颜色，默认值：'黑色'

阴影颜色。的值None采用比例因子为rho的原始艺术家颜色。

alpha浮点数，默认值：0.3

创建的阴影补丁的 Alpha 透明度。

rho浮点数，默认值：0.3

如果shadow_color 为，则应用于 rgbFace 颜色的比例因子None。

**kwargs

额外的关键字被存储并传递给 AbstractPathEffect._update_gc().

draw_path ( renderer , gc , tpath , affine , rgbFace )

覆盖标准 draw_path 以添加阴影偏移和必要的阴影颜色更改。

类 matplotlib.patheffects。SimplePatchShadow ( offset = (2, -2) , shadow_rgbFace = None , alpha = None , rho = 0.3 , ** kwargs )

基地：AbstractPathEffect

通过填充补丁的简单阴影。

参数：

偏移量（浮点数，浮点数），默认值：(2, -2)

阴影的 (x, y) 偏移量，以点为单位。

shadow_rgb面部颜色

阴影颜色。

alpha浮点数，默认值：0.3

创建的阴影补丁的 Alpha 透明度。

rho浮点数，默认值：0.3

如果未指定shadow_rgbFace，则应用于 rgbFace 颜色的比例因子。

**kwargs

额外的关键字被存储并传递给 AbstractPathEffect._update_gc().

draw_path ( renderer , gc , tpath , affine , rgbFace )

覆盖标准 draw_path 以添加阴影偏移和必要的阴影颜色更改。

类 matplotlib.patheffects。中风( offset = (0, 0) , ** kwargs )

基地：AbstractPathEffect

基于线条的 PathEffect 重新绘制笔画。

路径将使用给定的关键字参数更新其 gc，即，关键字参数应该是有效的 gc 参数值。

draw_path ( renderer , gc , tpath , affine , rgbFace )

使用更新的 gc 绘制路径。

类 matplotlib.patheffects。TickedStroke (偏移= (0, 0) ,间距= 10.0 ,角度= 45.0 ,长度= 1.4142135623730951 , ** kwargs )

基地：AbstractPathEffect

一个基于行的 PathEffect ，它绘制带有勾选样式的路径。

这种线型经常用于表示优化中的约束。刻度线可用于指示线的一侧无效或表示域的封闭边界（即墙壁或管道边缘）。

可以控制刻度的间距、长度和角度。

这种线型有时称为阴影线。

另请参阅轮廓演示示例。

另请参见优化示例中的等高线。

参数：

偏移量（浮点数，浮点数），默认值：(0, 0)

应用于路径的 (x, y) 偏移量，以点为单位。

间距浮动，默认值：10.0

刻度之间的间距（以点为单位）。

角度浮动，默认：45.0

路径和刻度之间的角度，以度为单位。角度的测量就像你是一只沿着曲线行走的蚂蚁，零度指向正前方，左侧 90 度，右侧 -90 度，身后 180 度。

长度浮点数，默认值：1.414

刻度相对于间距的长度。推荐长度 = 1.414 (sqrt(2))，当角度=45，长度=1.0，当角度=90，长度=2.0，当角度=60。

**kwargs

额外的关键字被存储并传递给 AbstractPathEffect._update_gc().

例子

请参阅TickedStroke 路径效果。

draw_path ( renderer , gc , tpath , affine , rgbFace )

使用更新的 gc 绘制路径。

类 matplotlib.patheffects。withSimplePatchShadow ( offset = (2, -2) , shadow_rgbFace = None , alpha = None , rho = 0.3 , ** kwargs )

基地：SimplePatchShadow

用于应用SimplePatchShadow并绘制原始 Artist 的快捷方式 PathEffect。

有了这个类，你可以使用

artist.set_path_effects([path_effects.withSimplePatchShadow()])

作为快捷方式

artist.set_path_effects([path_effects.SimplePatchShadow(),
                         path_effects.Normal()])

参数：

偏移量（浮点数，浮点数），默认值：(2, -2)

阴影的 (x, y) 偏移量，以点为单位。

shadow_rgb面部颜色

阴影颜色。

alpha浮点数，默认值：0.3

创建的阴影补丁的 Alpha 透明度。

rho浮点数，默认值：0.3

如果未指定shadow_rgbFace，则应用于 rgbFace 颜色的比例因子。

**kwargs

额外的关键字被存储并传递给 AbstractPathEffect._update_gc().

draw_path ( renderer , gc , tpath , affine , rgbFace )

覆盖标准 draw_path 以添加阴影偏移和必要的阴影颜色更改。

类 matplotlib.patheffects。withStroke ( offset = (0, 0) , ** kwargs )

基地：Stroke

用于应用Stroke并绘制原始 Artist 的快捷方式 PathEffect。

有了这个类，你可以使用

artist.set_path_effects([path_effects.withStroke()])

作为快捷方式

artist.set_path_effects([path_effects.Stroke(),
                         path_effects.Normal()])

路径将使用给定的关键字参数更新其 gc，即，关键字参数应该是有效的 gc 参数值。

draw_path ( renderer , gc , tpath , affine , rgbFace )

使用更新的 gc 绘制路径。

类 matplotlib.patheffects。withTickedStroke (偏移= (0, 0) ,间距= 10.0 ,角度= 45.0 ,长度= 1.4142135623730951 , ** kwargs )

基地：TickedStroke

用于应用TickedStroke并绘制原始 Artist 的快捷方式 PathEffect。

有了这个类，你可以使用

artist.set_path_effects([path_effects.withTickedStroke()])

作为快捷方式

artist.set_path_effects([path_effects.TickedStroke(),
                         path_effects.Normal()])

参数：

偏移量（浮点数，浮点数），默认值：(0, 0)

应用于路径的 (x, y) 偏移量，以点为单位。

间距浮动，默认值：10.0

刻度之间的间距（以点为单位）。

角度浮动，默认：45.0

路径和刻度之间的角度，以度为单位。角度的测量就像你是一只沿着曲线行走的蚂蚁，零度指向正前方，左侧 90 度，右侧 -90 度，身后 180 度。

长度浮点数，默认值：1.414

刻度相对于间距的长度。推荐长度 = 1.414 (sqrt(2))，当角度=45，长度=1.0，当角度=90，长度=2.0，当角度=60。

**kwargs

额外的关键字被存储并传递给 AbstractPathEffect._update_gc().

例子

请参阅TickedStroke 路径效果。

draw_path ( renderer , gc , tpath , affine , rgbFace )

使用更新的 gc 绘制路径。