plot_polar#

ReportPlotter.plot_polar(traces=None, to_polar=False, snapshot_path=None, show=True, is_degree=True, figure=None)#

Create a Matplotlib polar plot based on a list of data.

Parameters:
tracesint, str, list, optional

Trace or traces to be plotted. It can be the trace name, the trace id or a list of those.

to_polarbool, optional

Whether if cartesian data has to be converted to polar before the plot or can be used as is.

snapshot_pathstr

Full path to the image file if a snapshot is needed.

showbool, optional

Whether to render the figure. The default is True. If False, the figure is not drawn.

is_degreebool, optional

Whether if data source are in degree or not. Default is True.

figurematplotlib.pyplot.Figure, optional

An existing Matplotlib Figure to which the plot is added. If not provided, a new Figure and Axes object are created.

Returns:
matplotlib.pyplot.Figure

Matplotlib figure object.