matplotlib.patches.Arrow — Matplotlib 3.10.1 documentation (original) (raw)
class matplotlib.patches.Arrow(x, y, dx, dy, *, width=1.0, **kwargs)[source]#
Bases: Patch
An 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 Patch properties:
See also
Patch that allows independent control of the head and tail properties.
get_patch_transform()[source]#
Return the Transform instance 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.
Return the path of this patch.
set(*, agg_filter=, alpha=, animated=, antialiased=, capstyle=, clip_box=, clip_on=, clip_path=, color=, data=, edgecolor=, facecolor=, fill=, gid=, hatch=, hatch_linewidth=, in_layout=, joinstyle=, label=, linestyle=, linewidth=, mouseover=, path_effects=, picker=, rasterized=, sketch_params=, snap=, transform=, url=, visible=, zorder=)[source]#
Set multiple properties at once.
Supported properties are
set_data(x=None, y=None, dx=None, dy=None, width=None)[source]#
Set Arrow x, y, dx, dy and width. Values left as None will not be updated.
Parameters:
x, yfloat or None, default: None
The x and y coordinates of the arrow base.
dx, dyfloat or None, default: None
The length of the arrow along x and y direction.
widthfloat or None, default: None
Width of full arrow tail.