Report#

class ansys.dynamicreporting.core.Report(service=None, report_name='default', report_obj=None)#

Provides for generating the Report object for the database.

Parameters:
serviceansys.dynamicreporting.core.Service, optional

Ansys Dynamic Reporting object that provides the connection to the database. The default is None.

report_namestr, optional

Name of the report object in the database. The default is default.

report_objstr, optional

TemplateREST object from low-level ADR API. Do not modify.

Methods

Report.export_html([directory_name, query, ...])

Export report as static HTML.

Report.export_pdf([file_name, query, page, ...])

Export report as PDF.

Report.get_guid()

Get the guid corresponding to the report.

Report.get_iframe([width, height, filter])

Get the iframe object corresponding to the report.

Report.get_report_component([prefix, ...])

A HTML code of the web component for report fetching.

Report.get_report_script()

A block of JavaScript script to define the web component for report fetching.

Report.get_url([filter])

Get the URL corresponding to the report.

Report.visualize([new_tab, filter])

Render the report.