mark_arrow

mark_arrow(x: float | Sequence[float], y: float | Sequence[float], ax: Axes | None = None, *, alpha: float = 1.0, color: str = 'black', color_accent: str | None = None, linecolor: str = 'none', markersize: float = 15, rotate_angle: float = 20, **kwargs) None[source]

Draw arrow marker(s) at specified location(s) on a matplotlib plot.

This function creates an arrow glyph by combining and rotating matplotlib markers.

Parameters:
  • x (float or sequence of floats) – The x-coordinate(s) where the arrow(s) will be placed.

  • y (float or sequence of floats) – The y-coordinate(s) where the arrow(s) will be placed.

  • ax (mpl_axes.Axes, optional) – The axes object on which to draw the markers. If None, plt.gca() will be used.

  • alpha (float, default 1.0) – The transparency level of the markers.

  • color (str, default "black") – The primary color for the glyph components.

  • color_accent (Optional[str], optional) –

    The default accent color for the glyph.

    If color is “white”, defaults “black”. Otherwise, defaults “white”.

  • linecolor (str, default "none") – Color for connecting lines between markers, if any.

  • markersize (float, default 15) – Size for glyph’s largest marker element.

  • rotate_angle (float, default 20) – The angle (in degrees) to rotate the arrow part of the glyph.

  • **kwargs (dict, optional) – Additional keyword arguments forward to matplotlib plot.

Return type:

None

See also

outset.mark.MarkArrow

Functor interface for mark_arrow.