add_limit_line

ReportPlotter.add_limit_line(plot_data: list, hatch_above: bool = True, properties: dict = None, name: str = '') → bool

Add a new limit_line to the chart.

Parameters:

plot_datalist

Data to be inserted. Data has to be cartesian with x and y.

propertiesdict, optional

Properties of the trace. {x_label:prop, y_label:prop, trace_style : “-“, trace_width : 1.5, trace_color : None, symbol_style : ‘v’, fill_symbol : None, symbol_color : “C0” }

namestr

Line name.

Returns:

bool

Examples

>>> from ansys.aedt.core.visualization.plot.matplotlib import ReportPlotter
>>> obj = ReportPlotter()
>>> obj.add_limit_line([[0, 1], [0, 1]])