Fields

class pyaedt.modules.report_templates.Fields(app, report_category, setup_name, expressions=None)

Provides for managing fields.

Methods

Fields.add_cartesian_x_marker(val[, name])	Add a cartesian X marker.
Fields.add_cartesian_y_marker(val[, name, ...])	Add a cartesian Y marker.
Fields.add_limit_line_from_equation(start_x, ...)	Add a Cartesian limit line from point lists.
Fields.add_limit_line_from_points(x_list, y_list)	Add a Cartesian limit line from point lists.
Fields.add_note(text[, x_position, y_position])	Add a note at a position.
Fields.add_trace_to_report(traces[, ...])	Add a trace to a specific report.
Fields.create([plot_name])	Create a report.
Fields.delete()	Delete current report.
Fields.delete_traces(plot_name, traces_list)	Delete an existing trace or traces.
Fields.edit_general_settings([...])	Edit general settings for the plot.
Fields.edit_grid([minor_x, minor_y, ...])	Edit the grid settings for the plot.
Fields.edit_header([company_name, ...])	Edit the plot header.
Fields.edit_legend([show_solution_name, ...])	Edit the plot legend.
Fields.edit_x_axis([font, font_size, ...])	Edit the X-axis settings.
Fields.edit_x_axis_scaling([linear_scaling, ...])	Edit the X-axis scaling settings.
Fields.edit_y_axis([axis_name, font, ...])	Edit the Y-axis settings.
Fields.edit_y_axis_scaling([axis_name, ...])	Edit the Y-axis scaling settings.
Fields.get_solution_data()	Get the report solution data.
Fields.hide_legend([solution_name, ...])	Hide the Legend.
Fields.import_traces(file_path, plot_name)	Import report data from a file into a specified report.
Fields.update_expressions_with_defaults([...])	Update the list of expressions by taking all quantities from a given category.
Fields.update_trace_in_report(traces[, ...])	Update a trace in a specific report.

Attributes

Fields.differential_pairs	Differential pairs flag.
Fields.domain	Plot domain.
Fields.expressions	Expressions.
Fields.limit_lines	List of available limit lines in the report.
Fields.matrix	2D or Q3D matrix name.
Fields.notes	List of available notes in the report.
Fields.plot_name	Plot name.
Fields.point_number	Polygon point number.
Fields.polyline	Polyline name for the field report.
Fields.primary_sweep	Primary sweep report.
Fields.primary_sweep_range	Primary sweep range report.
Fields.report_category	Report category.
Fields.report_type	Report type.
Fields.secondary_sweep	Secondary sweep report.
Fields.secondary_sweep_range	Secondary sweep range report.
Fields.traces	List of available traces in the report.
Fields.use_pulse_in_tdr	Defines if the TDR should use a pulse or step.
Fields.variations	Variations.