visualize_report#

Service.visualize_report(report_name: str | None = '', new_tab: bool | None = False, filter: str | None = '') → None#

Render the report.

Parameters:

report_namestr, optional: Name of the report. the default is "", in which case all items assigned to the session are shown.
new_tabbool, optional: Whether to render the report in a new tab if the current environment is a Jupyter notebook. The default is False, in which case the report is rendered in the current location. If the environment is not a Jupyter notebook, the report is always rendered in a new tab.
filterstr, optional: Query string for filtering. The default is "". The syntax corresponds to the syntax for Ansys Dynamic Reporting. For more information, see _Query Expressions in the documentation for Ansys Dynamic Reporting.

Returns:

Report: Rendered report.

Raises:

ConnectionToServiceError: There is no ADR service associated with the current object.
MissingReportError: The service does not have a report with the input name.

Examples

import ansys.dynamicreporting.core as adr
installation_dir = r'C:\Program Files\ANSYS Inc\v232'
adr_service = adr.Service(ansys_installation = installation_dir)
ret = adr_service.connect()
my_img = adr_service.create_item()
my_img.item_image = 'Image_to_push_on_report'
adr_service.visualize_report()