add_cartesian_y_marker

EyeDiagram.add_cartesian_y_marker(value: str, name: str | None = None, y_axis: int = 1) → str

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.

Examples

>>> from ansys.aedt.core.visualization.report.common import CommonReport
>>> obj = CommonReport()
>>> obj.add_cartesian_y_marker("1V", y_axis=1)