FormPlotter.draw_arrows

FormPlotter.draw_arrows(arrows)[source]

Draws arrows on a 2D plot.

Parameters

arrows (list of dict) – List of dictionaries containing the arrow properties. The following properties of an arrow can be specified in the dict.

  • start (list): XY(Z) coordinates of the starting point.

  • end (list): XY(Z) coordinates of the end point.

  • text (str, optional): The text of the label. Default is None.

  • textcolor (rgb tuple or hex string, optional): Color of the label text. Default is black.

  • fontsize (int, optional): The size of the font of the label text. Default is 6.

  • color (rgb tuple or hex string, optional): Color of the arrow. Default is black.

  • width (float): Width of the arrow. Default is 1.0.

Returns

object – The matplotlib arrow collection object.