matplotlib.pyplot.arrow

matplotlib.pyplot.arrow(x, y, dx, dy, hold=None, **kwargs) [source]

Add an arrow to the axes.

This draws an arrow from (x, y) to (x+dx, y+dy).

Parameters:	x, y : float The x/y-coordinate of the arrow base. dx, dy : float The length of the arrow along x/y-direction.
Returns:	arrow : FancyArrow The created FancyArrow object.
Other Parameters:	**kwargs Optional kwargs (inherited from FancyArrow patch) control the arrow construction and properties: Constructor arguments 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. Other valid kwargs (inherited from :class:`Patch`) are: 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 float or None animated bool antialiased or aa bool or None capstyle ['butt' | 'round' | 'projecting'] clip_box a Bbox instance clip_on bool clip_path [(Path, Transform) | Patch | None] color matplotlib color spec contains a callable function edgecolor or ec mpl color spec, None, 'none', or 'auto' facecolor or fc mpl color spec, or None for default, or 'none' for no color figure a Figure instance fill bool gid an id string hatch ['/' | '\' | '|' | '-' | '+' | 'x' | 'o' | 'O' | '.' | '*'] joinstyle ['miter' | 'round' | 'bevel'] label object linestyle or ls ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) | '-' | '--' | '-.' | ':' | 'None' | ' ' | ''] linewidth or lw float or None for default path_effects AbstractPathEffect picker [None | bool | float | callable] rasterized bool or None sketch_params (scale: float, length: float, randomness: float) snap bool or None transform Transform url a url string visible bool zorder float

Notes

The resulting arrow is affected by the axes aspect ratio and limits. This may produce an arrow whose head is not square with its stem. To create an arrow whose head is square with its stem, use annotate() for example:

>>> ax.annotate("", xy=(0.5, 0.5), xytext=(0, 0),
...             arrowprops=dict(arrowstyle="->"))

Examples using matplotlib.pyplot.arrow

Arrow Demo