API REFERENCE

exportDataAsExcel

지정한 시트명·열·선택 조건으로 XLSX 파일을 내려받습니다.

무엇을 하는 API인가요

지정한 시트명·열·선택 조건으로 XLSX 파일을 내려받습니다.

Pro 기능 관련 API: Built-in Excel export

입력과 결과의 정확한 타입

typescript

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

인수	필수 여부	타입
options	선택	{ fileName?: string; sheetName?: string; onlySelected?: boolean; columnKeys?: readonly string[]; skipHeaders?: boolean; }

반환 타입은 Promise<void>입니다.

사용 흐름

등록과 초기화를 마친 Grid 요소에서 grid.exportDataAsExcel(…)를 호출합니다. 반환값은 await로 읽으세요. boolean이나 보고서를 반환하는 메서드는 결과를 확인한 뒤 다음 작업을 진행합니다.

기능별 설명과 예제

Excel 내보내기
Excel 내보내기는 XLSX 바이트를 생성하거나 파일로 내려받습니다. CSV보다 시트 이름과 워크북 형식이 필요한 교환 작업에 적합하며 Pro 기능입니다.