Standard#

class ansys.aedt.core.visualization.report.standard.Standard(app, report_category, setup_name, expressions=None)#

Provides a reporting class that fits most of the app’s standard reports.

Methods

`Standard.add_cartesian_x_marker`(value[, name])	Add a cartesian X marker.
`Standard.add_cartesian_y_marker`(value[, ...])	Add a cartesian Y marker.
`Standard.add_limit_line_from_equation`(...[, ...])	Add a Cartesian limit line from point lists.
`Standard.add_limit_line_from_points`(x_list, ...)	Add a Cartesian limit line from point lists.
`Standard.add_note`(text[, x_position, y_position])	Add a note at a position.
`Standard.add_trace_to_report`(traces[, ...])	Add a trace to a specific report.
`Standard.apply_report_template`(input_file[, ...])	Apply report template.
`Standard.create`([name])	Create a report.
`Standard.delete`()	Delete current report.
`Standard.delete_traces`(plot_name, traces_list)	Delete an existing trace or traces.
`Standard.edit_general_settings`([...])	Edit general settings for the plot.
`Standard.edit_grid`([minor_x, minor_y, ...])	Edit the grid settings for the plot.
`Standard.edit_header`([company_name, ...])	Edit the plot header.
`Standard.edit_legend`([show_solution_name, ...])	Edit the plot legend.
`Standard.edit_x_axis`([font, font_size, ...])	Edit the X-axis settings.
`Standard.edit_x_axis_scaling`([...])	Edit the X-axis scaling settings.
`Standard.edit_y_axis`([name, font, ...])	Edit the Y-axis settings.
`Standard.edit_y_axis_scaling`([name, ...])	Edit the Y-axis scaling settings.
`Standard.export_config`(output_file)	Generate a configuration file from active report.
`Standard.get_solution_data`()	Get the report solution data.
`Standard.hide_legend`([solution_name, ...])	Hide the Legend.
`Standard.import_traces`(input_file, plot_name)	Import report data from a file into a specified report.
`Standard.jsonalize_tree`()	Create dictionary from the Binary Tree.
`Standard.suppress_all`(app)	Activate suppress option for all the operations contained in the binary tree node.
`Standard.unsuppress_all`(app)	Disable suppress option for all the operations contained in the binary tree node.
`Standard.update_expressions_with_defaults`([...])	Update the list of expressions by taking all quantities from a given category.
`Standard.update_property`(prop_name, prop_value)	Update the property of the binary tree node.
`Standard.update_trace_in_report`(traces[, ...])	Update a trace in a specific report.

Attributes

`Standard.children`
`Standard.command`	Command of the modeler hystory if available.
`Standard.differential_pairs`	Differential pairs flag.
`Standard.domain`	Plot domain.
`Standard.expressions`	Expressions.
`Standard.limit_lines`	List of available limit lines in the report.
`Standard.matrix`	Maxwell 2D/3D or Q2D/Q3D matrix name.
`Standard.notes`	List of available notes in the report.
`Standard.plot_name`	Plot name.
`Standard.polyline`	Polyline name for the field report.
`Standard.primary_sweep`	Primary sweep report.
`Standard.primary_sweep_range`	Primary sweep range report.
`Standard.properties`	Properties data.
`Standard.pulse_rise_time`	Value of Pulse rise time for TDR plot.
`Standard.reduced_matrix`	Maxwell 2D/3D reduced matrix name for eddy current solvers.
`Standard.report_category`	Report category.
`Standard.report_type`	Report type.
`Standard.secondary_sweep`	Secondary sweep report.
`Standard.secondary_sweep_range`	Secondary sweep range report.
`Standard.sub_design_id`	Sub design ID for a Circuit or HFSS 3D Layout sub design.
`Standard.time_start`	Time start value.
`Standard.time_stop`	Time stop value.
`Standard.time_windowing`	Returns the TDR time windowing.
`Standard.traces`	List of available traces in the report.
`Standard.use_pulse_in_tdr`	Defines if the TDR should use a pulse or step.
`Standard.variations`	Variations.