export_html

Report.export_html(directory_name: str = '', query_params: dict | None = None, item_filter: str | None = None, filename: str | None = 'index.html', no_inline_files: bool | None = False) → bool

Export report as static HTML.

Parameters:

directory_namestr

Path for the HTML export directory

query_paramsdict, optional

Dictionary for parameters to apply to report template. Default: None

item_filter: str, optional

String corresponding to query to run on the database items before rendering the report. Default: None

filenamestr, optional

Filename for the exported static HTML file. Default: index.html

no_inline_filesbool, optional

If True, the information is exported as stand alone files instead of in line content in the static HTML. Default: False

Returns:

bool

Success status of the HTML export: True if it worked, False otherwise

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")
succ = my_report.export_html(directory_name = r'D:\tmp', query_params={"colormode": "dark"})
succ2 = my_report.export_html(filename=r'D:\tmp\onlyimages.pdf', item_filter = 'A|i_type|cont|image;')