visualize#

Report.visualize(new_tab: bool = False, filter: str = '') → None#

Render the report.

Parameters:

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.

Examples

Render a report in a new tab.

import ansys.dynamicreporting.core as adr
adr_service = adr.Service(ansys_installation = r'C:\Program Files\ANSYS Inc\v232')
ret = adr_service.connect()
my_report = adr_service.get_report(report_name = "My First Report")
my_report.visualize(new_tab = True)