export_report_as_pdf

ADR.export_report_as_pdf(*, filename: str | Path = None, context: dict | None = None, item_filter: str = '', **kwargs: Any) → None

Render a PDF report and write it to disk.

Parameters:

filenamestr or Path, optional

Target PDF filename. If omitted, use "<guid>.pdf" based on the template GUID.

contextdict, optional

Context to pass to the report template.

item_filterstr, optional

ADR filter applied to items in the report.

**kwargsAny

Additional keyword arguments to pass to the report template. Eg: guid, name, etc. At least one keyword argument must be provided to fetch the report.

Returns:

None

Raises:

ADRException

If no keyword arguments are provided or if the report rendering fails.

Examples

>>> from ansys.dynamicreporting.core.serverless import ADR
>>> adr = ADR(ansys_installation=r"C:\Program Files\ANSYS Inc\v252", db_directory=r"C:\DBs\docex")
>>> adr.setup()
>>> adr.export_report_as_pdf(filename="report.pdf", name="Serverless Simulation Report", item_filter="A|i_tags|cont|dp=dp227;")