matplotlib.patches.FancyArrow
-
class
matplotlib.patches.
FancyArrow
( x, y, dx, dy, width=0.001, length_includes_head=False, head_width=None, head_length=None, shape='full', overhang=0, head_starts_at_zero=False, **kwargs ) [source] -
Bases:
matplotlib.patches.Polygon
Like Arrow, but lets you set head width and head height independently.
Parameters: - width float, default: 0.001
-
Width of full arrow tail.
- length_includes_head bool, default: False
-
True if head is to be counted in calculating the length.
- head_width float or None, default: 3*width
-
Total width of the full arrow head.
- head_length float or None, default: 1.5*head_width
-
Length of arrow head.
- shape {'full', 'left', 'right'}, default: 'full'
-
Draw the left-half, right-half, or full arrow.
- overhang float, default: 0
-
Fraction that the arrow is swept back (0 overhang means triangular shape). Can be negative or greater than one.
- head_starts_at_zero bool, default: False
-
If True, the head starts being drawn at coordinate 0 instead of ending at coordinate 0.
- **kwargs
-
Patch
properties:Property Description agg_filter
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alpha
scalar or None animated
bool antialiased
or aaunknown capstyle
CapStyle
or {'butt', 'projecting', 'round'}clip_box
Bbox
clip_on
bool clip_path
Patch or (Path, Transform) or None color
color contains
unknown edgecolor
or eccolor or None or 'auto' facecolor
or fccolor or None figure
Figure
fill
bool gid
str hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layout
bool joinstyle
JoinStyle
or {'miter', 'round', 'bevel'}label
object linestyle
or ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidth
or lwfloat or None path_effects
AbstractPathEffect
picker
None or bool or float or callable rasterized
bool sketch_params
(scale: float, length: float, randomness: float) snap
bool or None transform
Transform
url
str visible
bool zorder
float
-
__init__
( x, y, dx, dy, width=0.001, length_includes_head=False, head_width=None, head_length=None, shape='full', overhang=0, head_starts_at_zero=False, **kwargs ) [source] -
Parameters: - width float, default: 0.001
-
Width of full arrow tail.
- length_includes_head bool, default: False
-
True if head is to be counted in calculating the length.
- head_width float or None, default: 3*width
-
Total width of the full arrow head.
- head_length float or None, default: 1.5*head_width
-
Length of arrow head.
- shape {'full', 'left', 'right'}, default: 'full'
-
Draw the left-half, right-half, or full arrow.
- overhang float, default: 0
-
Fraction that the arrow is swept back (0 overhang means triangular shape). Can be negative or greater than one.
- head_starts_at_zero bool, default: False
-
If True, the head starts being drawn at coordinate 0 instead of ending at coordinate 0.
- **kwargs
-
Patch
properties:Property Description agg_filter
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alpha
scalar or None animated
bool antialiased
or aaunknown capstyle
CapStyle
or {'butt', 'projecting', 'round'}clip_box
Bbox
clip_on
bool clip_path
Patch or (Path, Transform) or None color
color contains
unknown edgecolor
or eccolor or None or 'auto' facecolor
or fccolor or None figure
Figure
fill
bool gid
str hatch
{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layout
bool joinstyle
JoinStyle
or {'miter', 'round', 'bevel'}label
object linestyle
or ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidth
or lwfloat or None path_effects
AbstractPathEffect
picker
None or bool or float or callable rasterized
bool sketch_params
(scale: float, length: float, randomness: float) snap
bool or None transform
Transform
url
str visible
bool zorder
float
-
__module__
= 'matplotlib.patches'
-
__str__
( ) [source] -
Return str(self).
Examples using matplotlib.patches.FancyArrow
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.3/api/_as_gen/matplotlib.patches.FancyArrow.html