add_trace_to_report

AMIEyeDiagram.add_trace_to_report(traces: list, setup_name: str = None, variations: dict | None = None, context: list | None = None) → bool

Add a trace to a specific report.

Parameters:

traceslist

List of traces to add.

setup_namestr, optional

Name of the setup. The default is None which automatically take nominal_adaptive setup. Please make sure to build a setup string in the form of "SetupName : SetupSweep" where SetupSweep is the Sweep name to use in the export or LastAdaptive.

variationsdict, optional

Dictionary of variations. The default is None.

contextlist, optional

List of solution context.

Returns:

bool

True when successful, False when failed.

Examples

>>> from ansys.aedt.core.visualization.report.common import CommonReport
>>> obj = CommonReport()
>>> obj.add_trace_to_report(["Trace1", "Trace2"], setup_name="Setup1 : LastAdaptive")