hide_legend

NearField.hide_legend(solution_name: bool = True, trace_name: bool = True, variation_key: bool = True, font_size: int = 1) → bool

Hide the Legend.

Parameters:

solution_namebool, optional

Whether to show or hide the solution name. Default is True.

trace_namebool, optional

Whether to show or hide the trace name. Default is True.

variation_keybool, optional

Whether to show or hide the variations. Default is True.

font_sizeint

Font size. 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.hide_legend()