add_note

AMIConturEyeDiagram.add_note(text: str, x_position: float = 0.0, y_position: float = 0.0) → bool

Add a note at a position.

Parameters:

textstr

Text of the note.

x_positionfloat, optional

x position of the note. The default is 0.0.

y_positionfloat, optional

y position of the note. The default is 0.0.

Returns:

bool

True when successful, False when failed.

Examples

>>> from ansys.aedt.core.visualization.report.common import CommonReport
>>> obj = CommonReport()
>>> obj.add_note("Note text", 0.0, 0.0)