exportDataAsExcel

What does this API do?

Downloads an XLSX file using the specified sheet name, columns, and selection conditions.

API for Pro features: Built-in Excel export

Exact input and result types

exportDataAsExcel(options?: {
      fileName?: string;
      sheetName?: string;
      onlySelected?: boolean;
      columnKeys?: readonly string[];
      skipHeaders?: boolean;
    }): Promise<void>

The return type is Promise<void>.

Usage flow

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

Feature explanations and examples

• Excel export

  Excel export generates XLSX bytes or downloads a file. This Pro feature suits exchanges requiring sheet names and workbook format beyond CSV.