matplotlib.patches.Arrow¶
-
class
matplotlib.patches.Arrow(x, y, dx, dy, width=1.0, **kwargs)[source]¶ Bases:
matplotlib.patches.PatchAn arrow patch.
Draws an arrow from (x, y) to (x + dx, y + dy). The width of the arrow is scaled by width.
Parameters: - xfloat
x coordinate of the arrow tail.
- yfloat
y coordinate of the arrow tail.
- dxfloat
Arrow length in the x direction.
- dyfloat
Arrow length in the y direction.
- widthfloat, default: 1
Scale factor for the width of the arrow. With a default value of 1, the tail width is 0.2 and head width is 0.6.
- **kwargs
Keyword arguments control the
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 alphafloat or None animatedbool antialiasedor aaunknown capstyle{'butt', 'round', 'projecting'} 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 joinstyle{'miter', 'round', 'bevel'} labelobject linestyleor ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthor lwfloat or None path_effectsAbstractPathEffectpickerNone or bool or callable rasterizedbool or None sketch_params(scale: float, length: float, randomness: float) snapbool or None transformTransformurlstr visiblebool zorderfloat
See also
FancyArrow- Patch that allows independent control of the head and tail properties.
-
__init__(self, x, y, dx, dy, width=1.0, **kwargs)[source]¶ Draws an arrow from (x, y) to (x + dx, y + dy). The width of the arrow is scaled by width.
Parameters: - xfloat
x coordinate of the arrow tail.
- yfloat
y coordinate of the arrow tail.
- dxfloat
Arrow length in the x direction.
- dyfloat
Arrow length in the y direction.
- widthfloat, default: 1
Scale factor for the width of the arrow. With a default value of 1, the tail width is 0.2 and head width is 0.6.
- **kwargs
Keyword arguments control the
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 alphafloat or None animatedbool antialiasedor aaunknown capstyle{'butt', 'round', 'projecting'} 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 joinstyle{'miter', 'round', 'bevel'} labelobject linestyleor ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidthor lwfloat or None path_effectsAbstractPathEffectpickerNone or bool or callable rasterizedbool or None sketch_params(scale: float, length: float, randomness: float) snapbool or None transformTransformurlstr visiblebool zorderfloat
See also
FancyArrow- Patch that allows independent control of the head and tail properties.
-
__module__= 'matplotlib.patches'¶
-
get_patch_transform(self)[source]¶ Return the
Transforminstance mapping patch coordinates to data coordinates.For example, one may define a patch of a circle which represents a radius of 5 by providing coordinates for a unit circle, and a transform which scales the coordinates (the patch coordinate) by 5.