matplotlib.patches.ArrowStyle#

class matplotlib.patches.ArrowStyle(stylename, **kwargs)[源代码][源代码]#

基类:_Style

ArrowStyle 是一个容器类,它定义了几个箭头样式类,用于沿着给定路径创建箭头路径。这些主要与 FancyArrowPatch 一起使用。

一个 arrowstyle 对象可以被创建为:

ArrowStyle.Fancy(head_length=.4, head_width=.4, tail_width=.4)

或:

ArrowStyle("Fancy", head_length=.4, head_width=.4, tail_width=.4)

或:

ArrowStyle("Fancy, head_length=.4, head_width=.4, tail_width=.4")

以下类已定义

名称

Attrs

曲线

-

曲线A

<-

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

曲线B

->

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

曲线AB

<->

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

曲线填充

<|-

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

CurveFilledB

-|>

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

曲线填充AB

<|-|>

head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None

BracketA

]-

widthA=1.0, lengthA=0.2, angleA=0

BracketB

-[

widthB=1.0, lengthB=0.2, angleB=0

BracketAB

]-[

widthA=1.0, lengthA=0.2, angleA=0, widthB=1.0, lengthB=0.2, angleB=0

BarAB

|-|

widthA=1.0, angleA=0, widthB=1.0, angleB=0

BracketCurve

]->

widthA=1.0, lengthA=0.2, angleA=None

CurveBracket

<-[

widthB=1.0, lengthB=0.2, angleB=None

简单

simple

head_length=0.5, head_width=0.5, tail_width=0.2

花哨

fancy

head_length=0.4, head_width=0.4, tail_width=0.4

楔子

wedge

tail_width=0.3, shrink_factor=0.5

关于视觉效果的概览,请参阅 注释箭头样式参考

任何箭头样式类的实例都是一个可调用对象,其调用签名如下:

__call__(self, path, mutation_size, linewidth, aspect_ratio=1.)

它返回一个 Path 实例和一个布尔值的元组。path 是一个 Path 实例,箭头将沿着该路径绘制。mutation_sizeaspect_ratioBoxStyle 中的含义相同。linewidth 是要绘制的线宽。这用于校正箭头头部的位置,使其不会超过目标点,但并非所有类都支持这一点。

注释

angleAangleB 指定括号的方向,根据箭头类型可以是顺时针或逆时针角度。0度表示垂直于连接箭头头部和尾部的线。

(Source code, 2x.png, png)

返回具有给定样式名称的子类实例。

class BarAB(widthA=1.0, angleA=0, widthB=1.0, angleB=0)[源代码][源代码]#

基类:_Curve

两端带有垂直条 | 的箭头。

参数:
宽度A, 宽度B浮点数, 默认值: 1.0

括号的宽度。

角A, 角B浮动,默认:0度

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

arrow = '|-|'#
class BracketA(widthA=1.0, lengthA=0.2, angleA=0)[源代码][源代码]#

基类:_Curve

一个在其起点带有向外方括号的箭头。

参数:
宽度A浮点数, 默认值: 1.0

括号的宽度。

长度Afloat, 默认值: 0.2

括号的长度。

角度A浮动,默认:0度

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

arrow = ']-'#
class BracketAB(widthA=1.0, lengthA=0.2, angleA=0, widthB=1.0, lengthB=0.2, angleB=0)[源代码][源代码]#

基类:_Curve

两端带有向外方括号的箭头。

参数:
宽度A, 宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthA, lengthBfloat, 默认值: 0.2

括号的长度。

角A, 角B浮动,默认:0度

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

arrow = ']-['#
class BracketB(widthB=1.0, lengthB=0.2, angleB=0)[源代码][源代码]#

基类:_Curve

一个末端带有向外方括号的箭头。

参数:
宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthBfloat, 默认值: 0.2

括号的长度。

angleB浮动,默认:0度

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

arrow = '-['#
class BracketCurve(widthA=1.0, lengthA=0.2, angleA=None)[源代码][源代码]#

基类:_Curve

一个箭头,起始处有一个向外方的方括号,末端有一个箭头头。

参数:
宽度A浮点数, 默认值: 1.0

括号的宽度。

长度Afloat, 默认值: 0.2

括号的长度。

角度A浮动,默认:0度

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

arrow = ']->'#
class Curve[源代码][源代码]#

基类:_Curve

一条没有箭头的简单曲线。

参数:
head_lengthfloat, 默认值: 0.4

箭头头部的长度,相对于 mutation_size

head_widthfloat, 默认值: 0.2

箭头头部的宽度,相对于 mutation_size

宽度A, 宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthA, lengthBfloat, 默认值: 0.2

括号的长度。

角A, 角Bfloat, 默认值: 0

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

scaleA, scaleB : float, 默认值: mutation_size浮点数,默认值:

括号的规模。

class CurveA(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[源代码][源代码]#

基类:_Curve

一个在其起点带有箭头的箭头。

参数:
head_lengthfloat, 默认值: 0.4

箭头头部的长度,相对于 mutation_size

head_widthfloat, 默认值: 0.2

箭头头部的宽度,相对于 mutation_size

宽度A, 宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthA, lengthBfloat, 默认值: 0.2

括号的长度。

角A, 角Bfloat, 默认值: 0

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

scaleA, scaleB : float, 默认值: mutation_size浮点数,默认值:

括号的规模。

arrow = '<-'#
class CurveAB(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[源代码][源代码]#

基类:_Curve

一个在起点和终点都有箭头的箭头。

参数:
head_lengthfloat, 默认值: 0.4

箭头头部的长度,相对于 mutation_size

head_widthfloat, 默认值: 0.2

箭头头部的宽度,相对于 mutation_size

宽度A, 宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthA, lengthBfloat, 默认值: 0.2

括号的长度。

角A, 角Bfloat, 默认值: 0

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

scaleA, scaleB : float, 默认值: mutation_size浮点数,默认值:

括号的规模。

arrow = '<->'#
class CurveB(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[源代码][源代码]#

基类:_Curve

一个在其末端带有箭头的箭头。

参数:
head_lengthfloat, 默认值: 0.4

箭头头部的长度,相对于 mutation_size

head_widthfloat, 默认值: 0.2

箭头头部的宽度,相对于 mutation_size

宽度A, 宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthA, lengthBfloat, 默认值: 0.2

括号的长度。

角A, 角Bfloat, 默认值: 0

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

scaleA, scaleB : float, 默认值: mutation_size浮点数,默认值:

括号的规模。

arrow = '->'#
class CurveBracket(widthB=1.0, lengthB=0.2, angleB=None)[源代码][源代码]#

基类:_Curve

一个箭头,其末端带有向外方括号,起始端带有箭头。

参数:
宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthBfloat, 默认值: 0.2

括号的长度。

angleB浮动,默认:0度

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

arrow = '<-['#
class CurveFilledA(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[源代码][源代码]#

基类:_Curve

在起点带有填充三角形头的箭头。

参数:
head_lengthfloat, 默认值: 0.4

箭头头部的长度,相对于 mutation_size

head_widthfloat, 默认值: 0.2

箭头头部的宽度,相对于 mutation_size

宽度A, 宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthA, lengthBfloat, 默认值: 0.2

括号的长度。

角A, 角Bfloat, 默认值: 0

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

scaleA, scaleB : float, 默认值: mutation_size浮点数,默认值:

括号的规模。

arrow = '<|-'#
class CurveFilledAB(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[源代码][源代码]#

基类:_Curve

两端带有填充三角形头的箭头。

参数:
head_lengthfloat, 默认值: 0.4

箭头头部的长度,相对于 mutation_size

head_widthfloat, 默认值: 0.2

箭头头部的宽度,相对于 mutation_size

宽度A, 宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthA, lengthBfloat, 默认值: 0.2

括号的长度。

角A, 角Bfloat, 默认值: 0

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

scaleA, scaleB : float, 默认值: mutation_size浮点数,默认值:

括号的规模。

arrow = '<|-|>'#
class CurveFilledB(head_length=0.4, head_width=0.2, widthA=1.0, widthB=1.0, lengthA=0.2, lengthB=0.2, angleA=0, angleB=0, scaleA=None, scaleB=None)[源代码][源代码]#

基类:_Curve

末端带有填充三角形头的箭头。

参数:
head_lengthfloat, 默认值: 0.4

箭头头部的长度,相对于 mutation_size

head_widthfloat, 默认值: 0.2

箭头头部的宽度,相对于 mutation_size

宽度A, 宽度B浮点数, 默认值: 1.0

括号的宽度。

lengthA, lengthBfloat, 默认值: 0.2

括号的长度。

角A, 角Bfloat, 默认值: 0

括号的朝向,以逆时针角度表示。0度表示垂直于线条。

scaleA, scaleB : float, 默认值: mutation_size浮点数,默认值:

括号的规模。

arrow = '-|>'#
class Fancy(head_length=0.4, head_width=0.4, tail_width=0.4)[源代码][源代码]#

基类:_Base

一个华丽的箭头。仅适用于二次贝塞尔曲线。

参数:
head_lengthfloat, 默认值: 0.4

箭头头的长度。

head_widthfloat, 默认值: 0.4

箭头头的宽度。

tail_widthfloat, 默认值: 0.4

箭尾的宽度。

transmute(path, mutation_size, linewidth)[源代码][源代码]#

transmute 方法是 ArrowStyle 类的核心,必须在子类中重写。它接收 path 对象,箭头将沿此对象绘制,以及 mutation_size,用于缩放箭头头部等。linewidth 可用于调整路径,使其不超过给定点。它返回一个 Path 实例和一个布尔值的元组。布尔值指示路径是否可以填充。返回值也可以是相同长度的路径列表和布尔值列表。

class Simple(head_length=0.5, head_width=0.5, tail_width=0.2)[源代码][源代码]#

基类:_Base

一个简单的箭头。仅适用于二次贝塞尔曲线。

参数:
head_lengthfloat, 默认值: 0.5

箭头头的长度。

head_widthfloat, 默认值: 0.5

箭头头的宽度。

tail_widthfloat, 默认值: 0.2

箭尾的宽度。

transmute(path, mutation_size, linewidth)[源代码][源代码]#

transmute 方法是 ArrowStyle 类的核心,必须在子类中重写。它接收 path 对象,箭头将沿此对象绘制,以及 mutation_size,用于缩放箭头头部等。linewidth 可用于调整路径,使其不超过给定点。它返回一个 Path 实例和一个布尔值的元组。布尔值指示路径是否可以填充。返回值也可以是相同长度的路径列表和布尔值列表。

class Wedge(tail_width=0.3, shrink_factor=0.5)[源代码][源代码]#

基类:_Base

楔形(?)。仅适用于二次贝塞尔曲线。起点宽度为 tail_width,终点宽度为 0。中间点的宽度为 shrink_factor*x*tail_width

参数:
tail_widthfloat, 默认值: 0.3

尾部的宽度。

shrink_factorfloat, 默认值: 0.5

箭头中间点的宽度分数。

transmute(path, mutation_size, linewidth)[源代码][源代码]#

transmute 方法是 ArrowStyle 类的核心,必须在子类中重写。它接收 path 对象,箭头将沿此对象绘制,以及 mutation_size,用于缩放箭头头部等。linewidth 可用于调整路径,使其不超过给定点。它返回一个 Path 实例和一个布尔值的元组。布尔值指示路径是否可以填充。返回值也可以是相同长度的路径列表和布尔值列表。

使用 matplotlib.patches.ArrowStyle 的示例#

括号箭头上的角度注释

Angle annotations on bracket arrows

注释箭头样式参考

Annotation arrow style reference