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.PolygonLike Arrow, but lets you set head width and head height independently.
Parameters: -
widthfloat, default: 0.001 -
Width of full arrow tail.
-
length_includes_headbool, default: False -
True if head is to be counted in calculating the length.
-
head_widthfloat or None, default: 3*width -
Total width of the full arrow head.
-
head_lengthfloat 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.
-
overhangfloat, default: 0 -
Fraction that the arrow is swept back (0 overhang means triangular shape). Can be negative or greater than one.
-
head_starts_at_zerobool, default: False -
If True, the head starts being drawn at coordinate 0 instead of ending at coordinate 0.
- **kwargs
-
Patchproperties:Property Description agg_filtera filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alphascalar or None animatedbool antialiasedor aaunknown capstyleCapStyleor {'butt', 'projecting', 'round'}clip_boxBboxclip_onbool clip_pathPatch or (Path, Transform) or None colorcolor containsunknown edgecoloror eccolor or None or 'auto' facecoloror fccolor or None figureFigurefillbool gidstr hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layoutbool joinstyleJoinStyleor {'miter', 'round', 'bevel'}labelobject linestyleor ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthor lwfloat or None path_effectsAbstractPathEffectpickerNone or bool or float or callable rasterizedbool sketch_params(scale: float, length: float, randomness: float) snapbool or None transformTransformurlstr visiblebool zorderfloat
-
__init__(self, 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: -
widthfloat, default: 0.001 -
Width of full arrow tail.
-
length_includes_headbool, default: False -
True if head is to be counted in calculating the length.
-
head_widthfloat or None, default: 3*width -
Total width of the full arrow head.
-
head_lengthfloat 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.
-
overhangfloat, default: 0 -
Fraction that the arrow is swept back (0 overhang means triangular shape). Can be negative or greater than one.
-
head_starts_at_zerobool, default: False -
If True, the head starts being drawn at coordinate 0 instead of ending at coordinate 0.
- **kwargs
-
Patchproperties:Property Description agg_filtera filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alphascalar or None animatedbool antialiasedor aaunknown capstyleCapStyleor {'butt', 'projecting', 'round'}clip_boxBboxclip_onbool clip_pathPatch or (Path, Transform) or None colorcolor containsunknown edgecoloror eccolor or None or 'auto' facecoloror fccolor or None figureFigurefillbool gidstr hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layoutbool joinstyleJoinStyleor {'miter', 'round', 'bevel'}labelobject linestyleor ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthor lwfloat or None path_effectsAbstractPathEffectpickerNone or bool or float or callable rasterizedbool sketch_params(scale: float, length: float, randomness: float) snapbool or None transformTransformurlstr visiblebool zorderfloat
-
-
__module__ = 'matplotlib.patches'
-
__str__(self)[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.1/api/_as_gen/matplotlib.patches.FancyArrow.html