add_cartesian_x_marker

AMIEyeDiagram.add_cartesian_x_marker(value: str, name: str | None = None) → str

Add a cartesian X marker.

Note

This method only works in graphical mode.

Parameters:

valuestr

Value to apply with units.

namestr, optional

Marker name. The default is None.

Returns:

str

Marker name if created.

Examples

>>> from ansys.aedt.core.visualization.report.common import CommonReport
>>> obj = CommonReport()
>>> obj.add_cartesian_x_marker("1GHz")