Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 606ca15

Browse files
committed
Merge pull request matplotlib#941 from kaufman/FancyArrow_dochelp
 update axes.arrow() and patches.FancyArrow documentation
2 parents 88e5aae + 18ca812 commit 606ca15

File tree

2 files changed

+21
-12
lines changed

2 files changed

+21
-12
lines changed

‎lib/matplotlib/axes.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6372,9 +6372,9 @@ def arrow(self, x, y, dx, dy, **kwargs):
63726372
arrow(x, y, dx, dy, **kwargs)
63736373
63746374
Draws arrow on specified axis from (*x*, *y*) to (*x* + *dx*,
6375-
*y* + *dy*).
6375+
*y* + *dy*). Uses FancyArrow patch to construct the arrow.
63766376
6377-
Optional kwargs control the arrow properties:
6377+
Optional kwargs control the arrow construction and properties:
63786378
63796379
%(FancyArrow)s
63806380

‎lib/matplotlib/patches.py

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -920,21 +920,30 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False, \
920920
head_starts_at_zero=False,**kwargs):
921921
"""
922922
Constructor arguments
923+
*width*: float (default: 0.001)
924+
width of full arrow tail
923925
924-
*length_includes_head*:
925-
*True* if head is counted in calculating the length.
926+
*length_includes_head*: [True | False] (default: False)
927+
True if head is to be counted in calculating the length.
926928
927-
*shape*: ['full', 'left', 'right']
929+
*head_width*: float or None (default: 3*width)
930+
total width of the full arrow head
928931
929-
*overhang*:
930-
distance that the arrow is swept back (0 overhang means
931-
triangular shape).
932+
*head_length*: float or None (default: 1.5 * head_width)
933+
length of arrow head
932934
933-
*head_starts_at_zero*:
934-
If *True*, the head starts being drawn at coordinate 0
935-
instead of ending at coordinate 0.
935+
*shape*: ['full', 'left', 'right'] (default: 'full')
936+
draw the left-half, right-half, or full arrow
936937
937-
Valid kwargs are:
938+
*overhang*: float (default: 0)
939+
fraction that the arrow is swept back (0 overhang means
940+
triangular shape). Can be negative or greater than one.
941+
942+
*head_starts_at_zero*: [True | False] (default: False)
943+
if True, the head starts being drawn at coordinate 0
944+
instead of ending at coordinate 0.
945+
946+
Other valid kwargs (inherited from :class:`Patch`) are:
938947
%(Patch)s
939948
940949
"""

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /