add_cartesian_y_marker#

FarField.add_cartesian_y_marker(value, name=None, y_axis=1)#

Add a cartesian Y marker.

Note

This method only works in graphical mode.

Parameters:
valuestr, float

Value to apply with units.

namestr, optional

Marker name. The default is None.

y_axisstr, optional

Y axis. The default is "Y1".

Returns:
str

Marker name if created.