Parameters ---------- x, y : float The x and y coordinates of the arrow base. dx, dy : float The length of the arrow along x and y direction. width : float, default: 0.001 Width of full arrow tail. length_include
(self, x, y, dx, dy, *,
width=0.001, length_includes_head=False, head_width=None,
head_length=None, shape='full', overhang=0,
head_starts_at_zero=False, **kwargs)
| 1511 | |
| 1512 | @_docstring.interpd |
| 1513 | def __init__(self, x, y, dx, dy, *, |
| 1514 | width=0.001, length_includes_head=False, head_width=None, |
| 1515 | head_length=None, shape='full', overhang=0, |
| 1516 | head_starts_at_zero=False, **kwargs): |
| 1517 | """ |
| 1518 | Parameters |
| 1519 | ---------- |
| 1520 | x, y : float |
| 1521 | The x and y coordinates of the arrow base. |
| 1522 | |
| 1523 | dx, dy : float |
| 1524 | The length of the arrow along x and y direction. |
| 1525 | |
| 1526 | width : float, default: 0.001 |
| 1527 | Width of full arrow tail. |
| 1528 | |
| 1529 | length_includes_head : bool, default: False |
| 1530 | True if head is to be counted in calculating the length. |
| 1531 | |
| 1532 | head_width : float or None, default: 3*width |
| 1533 | Total width of the full arrow head. |
| 1534 | |
| 1535 | head_length : float or None, default: 1.5*head_width |
| 1536 | Length of arrow head. |
| 1537 | |
| 1538 | shape : {'full', 'left', 'right'}, default: 'full' |
| 1539 | Draw the left-half, right-half, or full arrow. |
| 1540 | |
| 1541 | overhang : float, default: 0 |
| 1542 | Fraction that the arrow is swept back (0 overhang means |
| 1543 | triangular shape). Can be negative or greater than one. |
| 1544 | |
| 1545 | head_starts_at_zero : bool, default: False |
| 1546 | If True, the head starts being drawn at coordinate 0 |
| 1547 | instead of ending at coordinate 0. |
| 1548 | |
| 1549 | **kwargs |
| 1550 | `.Patch` properties: |
| 1551 | |
| 1552 | %(Patch:kwdoc)s |
| 1553 | """ |
| 1554 | self._x = x |
| 1555 | self._y = y |
| 1556 | self._dx = dx |
| 1557 | self._dy = dy |
| 1558 | self._width = width |
| 1559 | self._length_includes_head = length_includes_head |
| 1560 | self._head_width = head_width |
| 1561 | self._head_length = head_length |
| 1562 | self._shape = shape |
| 1563 | self._overhang = overhang |
| 1564 | self._head_starts_at_zero = head_starts_at_zero |
| 1565 | self._make_verts() |
| 1566 | super().__init__(self.verts, closed=True, **kwargs) |
| 1567 | |
| 1568 | def set_data(self, *, x=None, y=None, dx=None, dy=None, width=None, |
| 1569 | head_width=None, head_length=None): |
nothing calls this directly
no test coverage detected