`matplotlib.patheffects`#

定义路径效果的类。路径效果在 Text、Line2D 和 Patch 中得到支持。

参见

路径效果指南

class matplotlib.patheffects.AbstractPathEffect(offset=(0.0, 0.0))[源代码][源代码]#

基类：object

路径效果的基类。

子类应重写 draw_path 方法以添加效果功能。

参数:

偏移量(float, float), 默认值: (0, 0): 应用于路径的 (x, y) 偏移量，以点为单位测量。

draw_path(renderer, gc, tpath, affine, rgbFace=None)[源代码][源代码]#: 派生类应重写此方法。参数与 matplotlib.backend_bases.RendererBase.draw_path() 相同，除了第一个参数是渲染器。

class matplotlib.patheffects.Normal(offset=(0.0, 0.0))[源代码][源代码]#

基类：AbstractPathEffect

“identity” PathEffect。

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

参数:

偏移量(float, float), 默认值: (0, 0): 应用于路径的 (x, y) 偏移量，以点为单位测量。

class matplotlib.patheffects.PathEffectRenderer(path_effects, renderer)[源代码][源代码]#

基类：RendererBase

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

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

备注

并非所有方法都在此 RendererBase 子类中被重写。可能需要添加更多方法以进一步扩展 PathEffects 的功能。

参数:

path_effects : AbstractPathEffect 的可迭代对象可迭代对象: 此渲染器所表示的路径效果。
渲染器 : RendererBase 子类RendererBase 子类

close_group(s)[源代码][源代码]#

用标签 s 关闭一个分组元素。

仅由SVG渲染器使用。

copy_with_path_effect(path_effects)[源代码][源代码]#

draw_markers(gc, marker_path, marker_trans, path, *args, **kwargs)[源代码][源代码]#

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

基础（回退）实现会多次调用 draw_path。后端可能希望重写此方法，以便只绘制一次标记并多次重用它。

参数:

gcGraphicsContextBase: 图形上下文。
marker_path路径: 标记的路径。
marker_trans转换: 应用于标记的仿射变换。
路径 : Path路径: 绘制标记的位置。
trans转换: 应用于路径的仿射变换。
rgbFace : color, 可选颜色, 可选

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 的行为。

open_group(s, gid=None)[源代码][源代码]#

使用标签 s 和 *gid*（如果设置）作为 id 打开一个分组元素。

仅由SVG渲染器使用。

class matplotlib.patheffects.PathPatchEffect(offset=(0, 0), **kwargs)[源代码][源代码]#

基类：AbstractPathEffect

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

参数:

偏移量(float, float), 默认值: (0, 0): 应用于路径的 (x, y) 偏移量，以点为单位。
**kwargs: 所有关键字参数都会传递给 PathPatch 构造函数。不能被覆盖的属性是 "path"、"clip_box"、"transform" 和 "clip_path"。

draw_path(renderer, gc, tpath, affine, rgbFace)[源代码][源代码]#: 派生类应重写此方法。参数与 matplotlib.backend_bases.RendererBase.draw_path() 相同，除了第一个参数是渲染器。

class matplotlib.patheffects.SimpleLineShadow(offset=(2, -2), shadow_color='k', alpha=0.3, rho=0.3, **kwargs)[源代码][源代码]#

基类：AbstractPathEffect

通过一条线的简单阴影。

参数:

偏移量(float, float), 默认值: (2, -2): 应用于路径的 (x, y) 偏移量，以点为单位。
shadow_color : color, 默认值: '黑色'颜色, 默认: '黑色': 阴影颜色。值为 None 时，采用原始艺术家的颜色，并乘以比例因子 rho。
alphafloat, 默认值: 0.3: 创建的阴影补丁的阿尔法透明度。
rhofloat, 默认值: 0.3: 如果 shadow_color 为 None，则应用于 rgbFace 颜色的比例因子。
**kwargs: 额外的关键词被存储并通过 AbstractPathEffect._update_gc() 传递。

draw_path(renderer, gc, tpath, affine, rgbFace)[源代码][源代码]#: 覆盖标准的 draw_path 以添加阴影偏移和阴影所需的颜色变化。

class matplotlib.patheffects.SimplePatchShadow(offset=(2, -2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[源代码][源代码]#

基类：AbstractPathEffect

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

参数:

偏移量(float, float), 默认值: (2, -2): 阴影的 (x, y) 偏移量，单位为点。
shadow_rgbFace颜色: 阴影颜色。
alphafloat, 默认值: 0.3: 创建的阴影补丁的阿尔法透明度。
rhofloat, 默认值: 0.3: 如果在未指定 shadow_rgbFace 的情况下，应用于 rgbFace 颜色的比例因子。
**kwargs: 额外的关键词被存储并通过 AbstractPathEffect._update_gc() 传递。

draw_path(renderer, gc, tpath, affine, rgbFace)[源代码][源代码]#: 覆盖标准的 draw_path 以添加阴影偏移和阴影所需的颜色变化。

class matplotlib.patheffects.Stroke(offset=(0, 0), **kwargs)[源代码][源代码]#

基类：AbstractPathEffect

基于行的 PathEffect，用于重新绘制笔画。

路径将使用其 gc 更新为给定的关键字参数进行描边，即关键字参数应为有效的 gc 参数值。

draw_path(renderer, gc, tpath, affine, rgbFace)[源代码][源代码]#: 使用更新的 gc 绘制路径。

class matplotlib.patheffects.TickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=np.float64(1.4142135623730951), **kwargs)[源代码][源代码]#

基类：AbstractPathEffect

一种基于线条的路径效果，以刻度样式绘制路径。

这种线条样式常用于表示优化中的约束。刻度可能用于指示线条一侧无效，或表示域的封闭边界（例如墙壁或管道的边缘）。

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

这种线条样式有时被称为阴影线。

另请参阅 TickedStroke 路径效果示例。

参数:

偏移量(float, float), 默认值: (0, 0): 应用于路径的 (x, y) 偏移量，以点为单位。
间距float, 默认值: 10.0: 刻度之间的间距，以点为单位。
角度浮点数，默认值：45.0: 路径与刻度之间的角度，以度为单位。角度的测量方式就像你是一只沿着曲线行走的蚂蚁，零度指向正前方，90度在你的左侧，-90度在你的右侧，180度在你身后。要改变刻度的侧面，请改变角度的符号。
长度float, 默认值: 1.414: 刻度相对于间距的长度。推荐长度：当角度=45时，长度=1.414（sqrt(2））；当角度=90时，长度=1.0；当角度=60时，长度=2.0。
**kwargs: 额外的关键词被存储并通过 AbstractPathEffect._update_gc() 传递。

示例

请参阅 TickedStroke 路径效果。

draw_path(renderer, gc, tpath, affine, rgbFace)[源代码][源代码]#: 使用更新的 gc 绘制路径。

class matplotlib.patheffects.withSimplePatchShadow(offset=(2, -2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[源代码]#

基类：SimplePatchShadow

一个快捷路径效果，用于应用 SimplePatchShadow 然后绘制原始艺术家。

使用这个类，你可以使用

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

作为 :: 的快捷方式

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

参数:

偏移量(float, float), 默认值: (2, -2): 阴影的 (x, y) 偏移量，单位为点。
shadow_rgbFace颜色: 阴影颜色。
alphafloat, 默认值: 0.3: 创建的阴影补丁的阿尔法透明度。
rhofloat, 默认值: 0.3: 如果在未指定 shadow_rgbFace 的情况下，应用于 rgbFace 颜色的比例因子。
**kwargs: 额外的关键词被存储并通过 AbstractPathEffect._update_gc() 传递。

draw_path(renderer, gc, tpath, affine, rgbFace)[源代码]#: 覆盖标准的 draw_path 以添加阴影偏移和阴影所需的颜色变化。

class matplotlib.patheffects.withStroke(offset=(0, 0), **kwargs)[源代码]#

基类：Stroke

一个快捷的 PathEffect，用于应用 Stroke 然后绘制原始的 Artist。

使用这个类，你可以使用

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

作为 :: 的快捷方式

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

路径将使用其 gc 更新为给定的关键字参数进行描边，即关键字参数应为有效的 gc 参数值。

draw_path(renderer, gc, tpath, affine, rgbFace)[源代码]#: 使用更新的 gc 绘制路径。

class matplotlib.patheffects.withTickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=np.float64(1.4142135623730951), **kwargs)[源代码]#

基类：TickedStroke

一个快捷路径效果，用于应用 TickedStroke 然后绘制原始艺术家。

使用这个类，你可以使用

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

作为 :: 的快捷方式

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

参数:

偏移量(float, float), 默认值: (0, 0): 应用于路径的 (x, y) 偏移量，以点为单位。
间距float, 默认值: 10.0: 刻度之间的间距，以点为单位。
角度浮点数，默认值：45.0: 路径与刻度之间的角度，以度为单位。角度的测量方式就像你是一只沿着曲线行走的蚂蚁，零度指向正前方，90度在你的左侧，-90度在你的右侧，180度在你身后。要改变刻度的侧面，请改变角度的符号。
长度float, 默认值: 1.414: 刻度相对于间距的长度。推荐长度：当角度=45时，长度=1.414（sqrt(2））；当角度=90时，长度=1.0；当角度=60时，长度=2.0。
**kwargs: 额外的关键词被存储并通过 AbstractPathEffect._update_gc() 传递。

示例

请参阅 TickedStroke 路径效果。

draw_path(renderer, gc, tpath, affine, rgbFace)[源代码]#: 使用更新的 gc 绘制路径。

matplotlib.patheffects#

`matplotlib.patheffects`#