wulfric.PlotlyEngine.plot_vector

method

PlotlyEngine.plot_vector(start_point, end_point, color='#000000', vector_label=None, legend_label=None, legend_group=None, row=1, col=1)

Plots a single vector pointing from start_point to end_point.

Parameters:

start_point(3, ) array-like

Start point of the vector.

end_point(3, ) array-like

End point of the vector.

colorstr, default "#000000"

Color of the vector and its label. Any value that is supported by Plotly.

vector_labelstr, optional

Label of the vector that is displayed in the figure.

legend_labelstr, optional

Label for the legend. Entry in legend only showed if legend_label is not None.

legend_groupstr, optional

Legend's group. If None, then defaults to the random string of 10 characters.

rowint, default 1

Row of the subplot.

colint, default 1

Column of the subplot.