add_limit_line_from_equation

AMIEyeDiagram.add_limit_line_from_equation(start_x: float, stop_x: float, step: float, equation: str = 'x', units: str = 'GHz', y_axis: int = 1) → bool

Add a Cartesian limit line from point lists. This method works only in graphical mode.

Parameters:

start_xfloat

Start X value.

stop_xfloat

Stop X value.

stepfloat

X step value.

equationstr, optional

Y equation to apply. The default is Y=X.

unitsstr

Units for the X axis. The default is "GHz".

y_axisstr, int, optional

Y axis. The default is 1.

Returns:

bool

True when successful, False when failed.

Examples

>>> from ansys.aedt.core.visualization.report.common import CommonReport
>>> obj = CommonReport()
>>> obj.add_limit_line_from_equation(0, 10, 1, "x", "GHz", 1)