class matplotlib.patches.ArrowStyle
[source]
Bases: matplotlib.patches._Style
ArrowStyle
is a container class which defines several arrowstyle classes, which is used to create an arrow path along a given path. These are mainly used with FancyArrowPatch
.
A arrowstyle object can be either created as:
ArrowStyle.Fancy(head_length=.4, head_width=.4, tail_width=.4)
or:
ArrowStyle("Fancy", head_length=.4, head_width=.4, tail_width=.4)
or:
ArrowStyle("Fancy, head_length=.4, head_width=.4, tail_width=.4")
The following classes are defined
Class | Name | Attrs |
---|---|---|
Curve | - | None |
CurveB | -> | head_length=0.4, head_width=0.2 |
BracketB | -[ | widthB=1.0, lengthB=0.2, angleB=None |
CurveFilledB | -|> | head_length=0.4, head_width=0.2 |
CurveA | <- | head_length=0.4, head_width=0.2 |
CurveAB | <-> | head_length=0.4, head_width=0.2 |
CurveFilledA | <|- | head_length=0.4, head_width=0.2 |
CurveFilledAB | <|-|> | head_length=0.4, head_width=0.2 |
BracketA | ]- | widthA=1.0, lengthA=0.2, angleA=None |
BracketAB | ]-[ | widthA=1.0, lengthA=0.2, angleA=None, widthB=1.0, lengthB=0.2, angleB=None |
Fancy | fancy | head_length=0.4, head_width=0.4, tail_width=0.4 |
Simple | simple | head_length=0.5, head_width=0.5, tail_width=0.2 |
Wedge | wedge | tail_width=0.3, shrink_factor=0.5 |
BarAB | |-| | widthA=1.0, angleA=None, widthB=1.0, angleB=None |
An instance of any arrow style class is a callable object, whose call signature is:
__call__(self, path, mutation_size, linewidth, aspect_ratio=1.)
and it returns a tuple of a Path
instance and a boolean value. path is a Path
instance along which the arrow will be drawn. mutation_size and aspect_ratio have the same meaning as in BoxStyle
. linewidth is a line width to be stroked. This is meant to be used to correct the location of the head so that it does not overshoot the destination point, but not all classes support it.
return the instance of the subclass with the given style name.
class BarAB(widthA=1.0, angleA=None, widthB=1.0, angleB=None)
[source]
Bases: matplotlib.patches._Bracket
An arrow with a bar(|) at both ends.
Parameters: |
|
---|
class BracketA(widthA=1.0, lengthA=0.2, angleA=None)
[source]
Bases: matplotlib.patches._Bracket
An arrow with a bracket(]) at its end.
Parameters: |
|
---|
class BracketAB(widthA=1.0, lengthA=0.2, angleA=None, widthB=1.0, lengthB=0.2, angleB=None)
[source]
Bases: matplotlib.patches._Bracket
An arrow with a bracket(]) at both ends.
Parameters: |
|
---|
class BracketB(widthB=1.0, lengthB=0.2, angleB=None)
[source]
Bases: matplotlib.patches._Bracket
An arrow with a bracket([) at its end.
Parameters: |
|
---|
class Curve
[source]
Bases: matplotlib.patches._Curve
A simple curve without any arrow head.
class CurveA(head_length=0.4, head_width=0.2)
[source]
Bases: matplotlib.patches._Curve
An arrow with a head at its begin point.
Parameters: |
|
---|
class CurveAB(head_length=0.4, head_width=0.2)
[source]
Bases: matplotlib.patches._Curve
An arrow with heads both at the begin and the end point.
Parameters: |
|
---|
class CurveB(head_length=0.4, head_width=0.2)
[source]
Bases: matplotlib.patches._Curve
An arrow with a head at its end point.
Parameters: |
|
---|
class CurveFilledA(head_length=0.4, head_width=0.2)
[source]
Bases: matplotlib.patches._Curve
An arrow with filled triangle head at the begin.
Parameters: |
|
---|
class CurveFilledAB(head_length=0.4, head_width=0.2)
[source]
Bases: matplotlib.patches._Curve
An arrow with filled triangle heads at both ends.
Parameters: |
|
---|
class CurveFilledB(head_length=0.4, head_width=0.2)
[source]
Bases: matplotlib.patches._Curve
An arrow with filled triangle head at the end.
Parameters: |
|
---|
class Fancy(head_length=0.4, head_width=0.4, tail_width=0.4)
[source]
Bases: matplotlib.patches._Base
A fancy arrow. Only works with a quadratic Bezier curve.
Parameters: |
|
---|
transmute(self, path, mutation_size, linewidth)
[source]
The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.
class Simple(head_length=0.5, head_width=0.5, tail_width=0.2)
[source]
Bases: matplotlib.patches._Base
A simple arrow. Only works with a quadratic Bezier curve.
Parameters: |
|
---|
transmute(self, path, mutation_size, linewidth)
[source]
The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.
class Wedge(tail_width=0.3, shrink_factor=0.5)
[source]
Bases: matplotlib.patches._Base
Wedge(?) shape. Only works with a quadratic Bezier curve. The begin point has a width of the tail_width and the end point has a width of 0. At the middle, the width is shrink_factor*tail_width.
Parameters: |
|
---|
transmute(self, path, mutation_size, linewidth)
[source]
The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to adjust the path so that it does not pass beyond the given points. It returns a tuple of a Path instance and a boolean. The boolean value indicate whether the path can be filled or not. The return value can also be a list of paths and list of booleans of a same length.
matplotlib.patches.ArrowStyle
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.patches.ArrowStyle.html