matplotlib.patches.
FancyArrowPatch
(posA=None, posB=None, path=None, arrowstyle='simple', arrow_transmuter=None, connectionstyle='arc3', connector=None, patchA=None, patchB=None, shrinkA=2, shrinkB=2, mutation_scale=1, mutation_aspect=None, dpi_cor=1, **kwargs)[source]¶A fancy arrow patch. It draws an arrow using the ArrowStyle
.
The head and tail positions are fixed at the specified start and end points of the arrow, but the size and shape (in display coordinates) of the arrow does not change when the axis is moved or zoomed.
If posA and posB are given, a path connecting two points is created according to connectionstyle. The path will be clipped with patchA and patchB and further shrunken by shrinkA and shrinkB. An arrow is drawn along this resulting path using the arrowstyle parameter.
Alternatively if path is provided, an arrow is drawn along this path and patchA, patchB, shrinkA, and shrinkB are ignored.
Parameters: |
|
---|
Notes
Valid kwargs 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 aabool or None capstyle
[‘butt’ | ‘round’ | ‘projecting’] clip_box
a Bbox
instanceclip_on
bool clip_path
[( Path
,Transform
) |Patch
| None]color
matplotlib color spec contains
a callable function edgecolor
or ecmpl color spec, None, ‘none’, or ‘auto’ facecolor
or fcmpl color spec, or None for default, or ‘none’ for no color figure
a Figure
instancefill
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 lwfloat 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
get_connectionstyle
()[source]¶Return the ConnectionStyle
instance.
get_dpi_cor
()[source]¶dpi_cor is currently used for linewidth-related things and shrink factor. Mutation scale is affected by this.
Returns: |
|
---|
get_path
()[source]¶Return the path of the arrow in the data coordinates. Use get_path_in_displaycoord() method to retrieve the arrow path in display coordinates.
set_arrowstyle
(arrowstyle=None, **kw)[source]¶Set the arrow style. Old attributes are forgotten. Without arguments
(or with arrowstyle=None
) returns available box styles as a list of
strings.
Parameters: |
|
---|
set_connectionstyle
(connectionstyle, **kw)[source]¶Set the connection style. Old attributes are forgotten.
Parameters: |
|
---|
set_dpi_cor
(dpi_cor)[source]¶dpi_cor is currently used for linewidth-related things and shrink factor. Mutation scale is affected by this.
Parameters: |
|
---|
set_mutation_aspect
(aspect)[source]¶Set the aspect ratio of the bbox mutation.
Parameters: |
|
---|
set_patchA
(patchA)[source]¶Set the tail patch.
Parameters: |
|
---|