ax_arrow
drawarrow.main.ax_arrow(tail_position, head_position, inflection_position=None, double_headed=False, fill_head=True, invert=False, radius=0, width=1, head_width=4, head_length=8, ax=None, shadow_style=None, **kwargs)
Draw an arrow on a Matplotlib axes using a FancyArrowPatch
. The coordinate system
used is that of a Matplotlib axes (data coordinates).
This function is very similar to what fig_arrow()
does: only the
change of coordinate system and the fig/ax
arguments. You can find out more about
how coordinate systems work in Matplotlib
here.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tail_position
|
list[float] | tuple[float]
|
Position of the tail of the arrow |
required |
head_position
|
list[float] | tuple[float]
|
Position of the head of the arrow |
required |
inflection_position
|
list[float] | tuple[float] | None
|
Current behavior may be unexpected and will probably change in the future. Optional position of the inflection point |
None
|
double_headed
|
bool
|
Whether the arrow has two heads or not |
False
|
fill_head
|
bool
|
Whether the arrowhead is filled or not |
True
|
invert
|
bool
|
Whether to invert or not the angle of the arrow (only used if |
False
|
radius
|
float
|
Rounding radius of the edge. If |
0
|
width
|
float
|
Width of the tail of the arrow |
1
|
head_width
|
float
|
Head width of the tail of the arrow |
4
|
head_length
|
float
|
Head length of the tail of the arrow |
8
|
ax
|
Axes | None
|
The matplotlib axes to draw the arrow on. If None, uses the current axes |
None
|
shadow_style
|
dict | None
|
dictionary with arguments passed to |
None
|
kwargs
|
any additional arguments passed to |
{}
|
Returns:
Type | Description |
---|---|
FancyArrowPatch
|
|
Examples
# mkdocs: render
import matplotlib.pyplot as plt
from drawarrow import ax_arrow
fig, ax = plt.subplots()
ax.scatter([1, 2, 3, 8, 6, 10], [2, 5, 3, 9, 2, 10])
ax_arrow(
head_position=[6, 7],
tail_position=[1, 1],
radius=0.3,
color="red",
fill_head=False, # don't fill head
ax=ax,
)
# mkdocs: render
import matplotlib.pyplot as plt
from drawarrow import ax_arrow
fig, ax = plt.subplots()
ax.scatter([1, 2, 3, 8, 6, 10], [2, 5, 3, 9, 2, 10])
ax_arrow(
head_position=[6, 7],
tail_position=[1, 1],
radius=0.3,
color="black",
double_headed=True, # arrow with 2 heads
ax=ax,
)
# mkdocs: render
import matplotlib.pyplot as plt
from drawarrow import ax_arrow
fig, ax = plt.subplots()
ax.scatter([1, 2, 3, 8, 6, 10], [2, 5, 3, 9, 2, 10])
ax_arrow(
head_position=[6, 7],
tail_position=[1, 1],
radius=0.9, # bended arrow
color="blue",
ax=ax,
)
# mkdocs: render
import matplotlib.pyplot as plt
from drawarrow import ax_arrow
fig, ax = plt.subplots()
ax.scatter([1, 2, 3, 8, 6, 10], [2, 5, 3, 9, 2, 10])
ax_arrow(
head_position=[6, 7],
tail_position=[1, 1],
head_length=20, # head length
head_width=10, # head width
color="#3a46a4",
ax=ax,
)
# mkdocs: render
import matplotlib.pyplot as plt
from drawarrow import ax_arrow
fig, ax = plt.subplots()
ax.scatter([1, 2, 3, 8, 6, 10], [2, 5, 3, 9, 2, 10])
ax_arrow(
head_position=[6, 7],
tail_position=[1, 1],
head_length=20, # head length
head_width=10, # head width
width=3,
radius=0.1,
shadow_style={"offset": (2.5, -4)},
color="#3aa484",
ax=ax,
)