API REFERENCE

exportDataAsPdf

Downloads the table as PDF and returns generation results.

What does this API do?

Downloads the table as PDF and returns generation results.

API for Pro features: Built-in PDF export

Exact input and result types

typescript

exportDataAsPdf(options?: SyGridPdfDownloadOptions): Promise<PdfExportResult>

Arguments	Required	Type
options	Optional	SyGridPdfDownloadOptions

The return type is Promise<PdfExportResult>.

Usage flow

After registering and initializing the Grid element, call grid.exportDataAsPdf(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Read related types

SyGridPdfDownloadOptions
PdfExportResult

Feature explanations and examples

PDF export
PDF export fixes the table into a shareable document. Choose CSV or XLSX for further calculation in other apps, and PDF for reading and distribution.