plotly_arrow#

ifermi.plot.plotly_arrow(start, stop, color, line_kwargs=None, cone_kwargs=None)[source]#

Create an arrow object.

Parameters:

  • start (ndarray) – The starting coordinates.

  • stop (ndarray) – The ending coordinates.

  • color (tuple[float, float, float]) – The arrow color in rgb format as a tuple of floats from 0 to 1.

  • line_kwargs (Optional[dict[str, Any]]) – Additional keyword arguments used to style the arrow shaft and that are passed to Scatter3d.

  • cone_kwargs (Optional[dict[str, Any]]) – Additional keyword arguments used to style the arrow cone and that are passed to Cone.

Return type:

tuple[Any, Any]

Returns:

The arrow, formed by a line and cone.