matplotlib.patches.Arrow

class matplotlib.patches.Arrow(x, y, dx, dy, width=1.0, **kwargs) [source]

An arrow patch.

Draws an arrow from (x, y) to (x + dx, y + dy). The width of the arrow is scaled by width.

Parameters:

x : scalar x coordinate of the arrow tail y : scalar y coordinate of the arrow tail dx : scalar Arrow length in the x direction dy : scalar Arrow length in the y direction width : scalar, optional (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: 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

See also

FancyArrow

Patch that allows independent control of the head and tail properties

get_patch_transform() [source]

Return the Transform instance which takes 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.

get_path() [source]

Return the path of this patch

Examples using matplotlib.patches.Arrow

Reference for matplotlib artists