chart_series_child

class ansys.cfx.core.generated.post_processing.settings_261.chart_series_child.chart_series_child(name: str | None = None, parent=None)

Bases: Group

‘child_object_type’ of chart_series.

Attributes

Attribute	Summary
add_chart_line_label	If true, will display chart line labels in the chart if available.
add_chart_line_label_border	If true, will add a non-transparent border for chart line label.
chart_contour_data_source	The chart source data for a chart contour.
chart_contour_level_count	Specifies number of contour lines for a chart contour plot.
chart_contour_parent	The name of the parent chart series for a contour plot across a chart point cloud.
chart_contour_range_max	The maximum value specified for a chart contour plot.
chart_contour_range_min	The minimum value specified for a chart contour plot.
chart_contour_range_type	Sets contour range type for a chart contour plot.
chart_contour_range_value_list	Specifies a list of values for the contour variable on a chart contour plot.
chart_contour_variable	The name of contour variable for a chart contour plot.
chart_data_source	The data source for a scatter chart. The ‘Chart Points’ option refers to the original chart points data. The ‘Response Points’ option refers to the sampled points on the response surfaces for the chart points.
chart_line_custom_data_selection	If true, use variable information stored in line object.
chart_line_filename	Specifies the file from which to read the line data.
chart_line_label_background_colour	A list of three numbers between 0 and 1, which represent the RGB (Red/Green/Blue) values to be used when colouring chart line label background.
chart_line_label_font_size	Parameter to control the line label font size.
chart_line_label_number_automatic_formatting	Parameter to display label numbers in an automatic format.
chart_line_label_number_format	Parameter to modify string format of numeric values on a chart line, i.e., a contour level.
chart_line_label_position	Parameter to control the line label position.
chart_line_label_text_colour	A list of three numbers between 0 and 1, which represent the RGB (Red/Green/Blue) values to be used when colouring chart line label text.
chart_plot_option	The parameter used to define the type of a chart plot.
chart_series_type	Indicates whether this line should be defined the regular way (i.e. get data from a locator in the loaded file), or defined via data from a file.
chart_x_variable	Specifies the name of the X-Axis variable to chart. The default value of ‘Chart Count’ indicates that the X-Axis will be a locator point counter.
chart_y_variable	Specifies the name of the Y-Axis variable to chart.
file_data_section_name	The name of file section to read xy data from.
file_data_x_variable	The name of variable to plot on the X Axis.
file_data_y_variable	The name of variable to plot on the Y Axis.
histogram_y_axis_weighting	Specifies how to calculate mesh bin information.
location	A locator name.
monitor_data_filename	The name of file from which the monitor data will be read.
monitor_data_source	Whether the monitor data is to be read from the case or filename.
monitor_data_x_variable	The name of variable to plot on the X Axis.
monitor_data_x_variable_absolute_value	Indicates whether to take the absolute value of the X Axis data before plotting the chart. If plotting a logarithmic chart, the minimum value will be 1e-100.
monitor_data_y_variable	The name of variable to plot on the Y Axis.
monitor_data_y_variable_absolute_value	Indicates whether to take the absolute value of the Y Axis data before plotting the chart. If plotting a logarithmic chart, the minimum value will be 1e-100.
operating_point_data_case	The name of the case from which the monitor data will be read.
operating_point_data_filename	The name of file from which the monitor data will be read.
operating_point_data_source	Whether the monitor data is to be read from the case or filename.
operating_point_data_x_variable	The name of variable to plot on the X Axis.
operating_point_data_y_variable	The name of variable to plot on the Y Axis.
random_seed	The seed to be used for a random number series.
results_set	Specifies which result sets to use.
series_name	The name of this chart line. This string will be used as the label in the Legend if one is displayed.
time_chart_expression	Specifies the expression to evaluate at each timestep and plot in the chart on the y axis.
time_chart_location	Specifies the location to use for the Time Chart.
time_chart_type	Indicates the type of Time Chart to create - the options are ‘Point’, which will track the value of a variable at that point over time, or ‘Expression’, which must evaluate to a single value, and will be evaluated for each timestep.
time_chart_variable	Specifies the name of the variable to track over time at the specified point.
time_chart_x_expression	Specifies the expression to evaluate at each timestep and plot in the chart.
time_variable_absolute_value	Indicates whether to take the absolute value of the Time Variable data before plotting the chart. If plotting a logarithmic chart, the minimum value will be 1e-100.
time_variable_boundary_values	Sets the type of boundary values to be used for the Time Chart variable (Conservative or Hybrid).
x_variable_absolute_value	Indicates whether to take the absolute value of the X Axis data before plotting the chart. If plotting a logarithmic chart, the minimum value will be 1e-100.
x_variable_boundary_values	Sets the type of boundary values to be used for the X Axis variable (Conservative or Hybrid).
y_variable_absolute_value	Indicates whether to take the absolute value of the Y Axis data before plotting the chart. If plotting a logarithmic chart, the minimum value will be 1e-100.
y_variable_boundary_values	Sets the type of boundary values to be used for the Y Axis variable (Conservative or Hybrid).
chart_line	‘chart_line’ child.

Methods

Method	Summary
suspend	Suspend immediate update for the object.
unsuspend	Restore immediate update for the object.

Included in:

Parent	Summary
chart_series	‘chart_series’ child.