add_trace_characteristics

FarField.add_trace_characteristics(name: str, arguments: list = None, solution_range: list = None) → bool

Add a trace characteristic to the plot.

Parameters:

namestr

Name of the trace characteristic.

argumentslist, optional

Arguments if any. The default is None.

solution_rangelist, optional

Output range. The default is None, in which case the full range is used.

Returns:

bool

True when successful, False when failed.

Examples

>>> from ansys.aedt.core.visualization.report.common import CommonReport
>>> obj = CommonReport()
>>> obj.add_trace_characteristics(name="XAtYVal")