가이드
내보내기(Export)

내보내기(Export)

Excel / CSV / PDF 보내기 옵션과 UI·API 호출 방법을 안내합니다.

피벗 테이블을 Excel(.xlsx), CSV, PDF 파일로 다운로드할 수 있습니다.
메뉴바의 내보내기에서 형식을 고르거나, API로 동일 다이얼로그를 띄울 수 있습니다.

Book 개요는 피벗 북(Book)을 참고하세요.

외부 모듈 등록

CSV는 추가 라이브러리 없이 동작합니다. Excel·PDF는 각각 ExcelJS, jsPDFuse / useAll로 등록해야 합니다. 등록되지 않으면 해당 메뉴 항목이 비활성화됩니다.

import * as ExcelJS from 'exceljs';
import * as jsPDF from 'jspdf';
import { useAll } from 'realpivot2';
 
useAll({
  ExcelJS,
  jsPDF,
});

React·Vue에서는 컴포넌트의 modules prop으로 동일하게 전달할 수 있습니다. (React 개발 가이드 · Vue 개발 가이드)

어디에 지정하나요

계층속성역할
Book exportcsv · excel · pdf형식별 기본 옵션(PivotCsvExportOptions 등)
Book generalexportable내보내기 사용 여부
const config = {
  general: {
    exportable: true,
  },
  export: {
    excel: {
      fileName: 'sales-report',
      includeHeaders: true,
      includeStyles: true,
    },
    csv: {
      fileName: 'sales-report',
      includeHeaders: true,
    },
    pdf: {
      fileName: 'sales-report',
      landscape: true,
      fontUrl: './asset/font/NotoSansKR-Regular.ttf',
      fontName: 'NotoSansKR-Regular',
    },
  },
  tables: {
    name: 'sales',
    cube: 'sales',
    // fields ...
  },
};

다이얼로그를 열면 위 기본값이 초기값으로 채워지며, 사용자가 파일명·옵션을 바꾼 뒤 내보낼 수 있습니다.

공통 옵션

Excel · CSV · PDF에 공통으로 쓰이는 항목입니다. (PivotExportOptions)

속성설명기본값
fileName파일 이름(확장자 제외)'realpivot'
fileExt확장자형식별 (xlsx / csv / pdf)
includeHeaders행·열 헤더 포함 여부true
includeStyles셀 스타일 포함 여부(Excel에서 적용)true

Excel

확장자 기본값은 xlsx입니다. includeStylestrue이면 값 셀의 글자색·배경색 등 스타일을 시트에 반영합니다.

export: {
  excel: {
    fileName: 'pivot-excel',
    includeHeaders: true,
    includeStyles: true,
  },
}

전체 항목은 Config · export · excel · PivotExcelExportOptions를 참고하세요.

CSV

확장자 기본값은 csv입니다. 헤더 포함 여부와 파일명만 지정하면 됩니다.

export: {
  csv: {
    fileName: 'pivot-csv',
    includeHeaders: true,
  },
}

전체 항목은 Config · export · csv · PivotCsvExportOptions를 참고하세요.

PDF

확장자 기본값은 pdf입니다. 가로 방향(landscape)과 폰트를 추가로 지정할 수 있습니다.

속성설명기본값
landscape가로 방향 출력true
fontUrl사용할 TTF 폰트 URL
fontNamefontUrl로 로드한 폰트의 내부 이름

한글 등 CJK 문자를 출력하려면 fontUrlTTF 파일을 지정하세요. jsPDF는 TTF만 지원합니다.

export: {
  pdf: {
    fileName: 'pivot-pdf',
    landscape: true,
    fontUrl: './asset/font/NotoSansKR-Regular.ttf',
    fontName: 'NotoSansKR-Regular',
  },
}

전체 항목은 Config · export · pdf · PivotPdfExportOptions를 참고하세요.

화면에서 내보내기

메뉴바 내보내기 하위 메뉴

메뉴바의 내보내기를 누르면 Excel / CSV / PDF 하위 메뉴가 열립니다. 항목을 선택하면 해당 형식의 다이얼로그가 표시됩니다.

다이얼로그설정 항목
엑셀 내보내기파일명, 헤더 포함, 스타일 포함
CSV 내보내기파일명, 헤더 포함
PDF 내보내기파일명, 가로 방향, 헤더 포함, 스타일 포함

확인 버튼(내보내기)을 누르면 파일이 다운로드됩니다.

API로 내보내기

book.export(type)을 호출하면 메뉴와 동일하게 다이얼로그가 열립니다. type 파라미터값은 'excel', 'csv', 'pdf' 중 하나입니다.

const book = control.book;
 
book.export('excel');
book.export('csv');
book.export('pdf');

옵션 변경 규칙은 개발 가이드를 참고하세요.

See Also