chart_child

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

Bases: Group

‘child_object_type’ of chart.

Attributes

Attribute	Summary
chart_axes	Indicates whether the X=0 or Y=0 lines should be displayed on the chart. Neither, either or both may be displayed.
chart_axes_font	The font definition for the Chart Axes. The parameter is a comma delimited list of four items: Font Name, Font Size, Bold (True or False), Italics (True or False), Underline (True or False), Strike Out (True or False).
chart_axes_titles_font	The font definition for the Chart Axes Titles. The parameter is a comma delimited list of four items: Font Name, Font Size, Bold (True or False), Italics (True or False), Underline (True or False), Strike Out (True or False).
chart_grid_line_width	Defines the line width for the major grid lines.
chart_horizontal_grid	Shows or hides the horizontal major grid.
chart_legend	Specifies whether a legend should be displayed or not.
chart_legend_font	The font definition for the Chart Legend. The parameter is a comma delimited list of four items: Font Name, Font Size, Bold (True or False), Italics (True or False), Underline (True or False), Strike Out (True or False).
chart_legend_inside	Specifies whether a legend should be displayed or not.
chart_legend_justification	Specifies the justification of the legend items inside of legend.
chart_legend_position	Specifies which side of the chart to place the legend.
chart_legend_width_height	Specifies the width-height of the legend.
chart_legend_x_justification	Specifies the legend orientation inside of chart on x-axis.
chart_legend_xy_position	Specifies the left-bottom corner of the legend.
chart_legend_y_justification	Specifies the legend orientation inside of chart on y-axis.
chart_line_width	Defines the line width for the chart lines.
chart_lines_order	List of line names that determines order.
chart_minor_grid	Shows or hides both Horizontal and Vertical Minor grid.
chart_minor_grid_line_width	Defines the line width for the minor grid lines.
chart_print_base_height	The image height for which the scaling is based on.
chart_print_base_width	The image width for which the scaling is based on.
chart_symbol_size	Defines the size of the chart symbols.
chart_text_colour	The colour of the chart title and X & Y Axis Labels. DEPRECATED.
chart_title	Specifies the title for the chart.
chart_title_font	The font definition for the Chart Title. The parameter is a comma delimited list of four items: Font Name, Font Size, Bold (True or False), Italics (True or False), Underline (True or False), Strike Out (True or False).
chart_title_visibility	Specifies whether the Chart Title should be displayed.
chart_type	Specifies the type of chart to create.
chart_vertical_grid	Shows or hides the Vertical major grid.
chart_viewport_colour	The colour of the chart viewport including axes, tick marks, and axis numbering. DEPRECATED.
chart_x_axis_automatic_number_formatting	Parameter to display x axis numbers in an automatic format.
chart_x_axis_label	The label to use for the X-Axis. The <units> token will be replaced with the X Axis units of the first line in the chart.
chart_x_axis_number_format	Parameter to modify string format of values on the x axis.
chart_y_axis_automatic_number_formatting	Parameter to display y axis numbers in an automatic format.
chart_y_axis_label	The label to use for the Y-Axis. The <units> token will be replaced with the Y Axis units of the first line in the chart.
chart_y_axis_number_format	Parameter to modify string format of values on the y axis.
default_chart_x_variable	Specifies the name of the X-Axis variable to chart.
default_chart_y_variable	Specifies the name of the Y-Axis variable to chart.
default_difference_line_calculation	‘default_difference_line_calculation’ child.
default_histogram_y_axis_weighting	Specifies how to calculate mesh bin information.
default_time_chart_variable	Specifies the name of the variable to track over time at the specified point.
default_time_chart_x_expression	Specifies the expression to evaluate at each timestep and plot in the chart.
default_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.
default_time_variable_boundary_values	Sets the type of boundary values to be used for the Time Chart variable (Conservative or Hybrid).
default_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.
default_x_variable_boundary_values	Sets the type of boundary values to be used for the X Axis variable (Conservative or Hybrid).
default_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.
default_y_variable_boundary_values	Sets the type of boundary values to be used for the Y Axis variable (Conservative or Hybrid).
fft_full_input_range	The data should be clipped to the specified range.
fft_max	The maximum range value to clip fft signal by.
fft_min	The minimum range value to clip fft signal by.
fft_subtract_mean	Subtract the mean value of the signal data.
fft_window_type	The window type to be used in processing signal data.
fft_x_function	The x function to be applied to the FFT signal processing.
fft_y_function	The x function to be applied to the FFT signal processing.
histogram_automatic_divisions	Determines how to process the histogram bins.
histogram_divisions	List of user defined category histogram bins.
histogram_divisions_count	The number of divisions when automatically calculating category histogram bins.
histogram_y_axis_value	Specifies how to calculate bin information.
is_fft_chart	Toggles if FFT should be run on the data.
max_x	If the ‘X Axis Automatic Range’ parameter is False, this parameter will indicate the maximum X value to display.
max_y	If the ‘Y Axis Automatic Range’ parameter is False, this parameter will indicate the maximum Y value to display.
min_x	If the ‘X Axis Automatic Range’ parameter is False, this parameter will indicate the minimum X value to display.
min_y	If the ‘Y Axis Automatic Range’ parameter is False, this parameter will indicate the minimum Y value to display.
time_chart_keep_single_case	If true, then do not calculate the time chart using multi-case or comparison, if originally created in single case mode.
use_data_for_x_axis_labels	Boolean indicating whether to use the line axis data as the X axis labels. (e.g. When plotting Pressure vs. X, the axis labels would be Pressure and X.).
use_data_for_y_axis_labels	Boolean indicating whether to use the line axis data as the Y axis labels.
x_axis_automatic_range	Indicates whether the Min and Max X values shown on the chart will be automatically (true) or manually determined.
x_axis_inverted	Indicates whether to invert the X Axis.
x_axis_logarithmic_scaling	Indicates whether to scale the X Axis linearly or logarithmically.
y_axis_automatic_range	Indicates whether the Min and Max Y values shown on the chart will be automatically (true) or manually determined.
y_axis_inverted	Indicates whether to invert the Y Axis.
y_axis_logarithmic_scaling	Indicates whether to scale the Y Axis linearly or logarithmically.
chart_series	‘chart_series’ child.
object_report_options	Defines options for the Report, specific to each object.

Methods

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

Included in:

Parent	Summary
chart	‘chart’ child.