polar_chart#

polar_chart(data: list[DataFrame], root: STKObjectRoot, numerical_columns: list[str], axis: dict, title: str, origin_0: bool = False, convert_negative_r: bool = False, colormap: Colormap = None) Figure, Axes#

Create a polar chart from the provided dataframe and axis information.

Parameters:

data : list of DataFrame The list of DataFrames containing the data.

root : STKObjectRoot The STK object root.

numerical_columns : list of str The list of dataframe columns with numerical values.

axis : dict The dictionary containing information about the data to plot.

title : str The title of the chart.

origin_0 : bool Whether to set the theta 0 point to the top of the graph.

convert_negative_r : bool Whether to convert negative radius values by using opposite angle values.

colormap : Colormap The colormap with which to color the lines (the default is None).

Returns:

Figure The newly created figure.

Axes The newly created axes.

Import detail#

from ansys.stk.extensions.data_analysis.graphs.graph_helpers import polar_chart