get_iframe#

Report.get_iframe(width: int = 1000, height: int = 800, filter: str = '', item_filter: str = '')#

Get the iframe object corresponding to the report.

Parameters:

widthint, optional: Width of the iframe object. The default is 1000.
heightint, optional: Height of the iframe object. The default is 800.
filterstr, optional: DEPRECATED. Use item_filter instead. 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.
item_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:

iframe: iframe object corresponding to the report. If no iframe can be generated, None is returned.

Examples

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 Top Report")
report_iframe = my_report.get_iframe()