React PivotGrid - export

Configures client-side exporting.

Selector: Export
Type:

Object

A user can click the Export button to save an Excel file with the exported data. Data types, sort, filter, and group settings are maintained.

View Demo

The following instructions show how to enable and configure client-side export:

  1. Install or reference the required libraries
    This feature requires ExcelJS v4.4.0+ and FileSaver v2.0.2+. If you apply CSP rules, refer to the ExcelJS CSP Treats section to read more about potential vulnerabilities.

    Installation command
    tsconfig.app.json
    • npm install --save exceljs file-saver
    • {
    • "compilerOptions": {
    • // ...
    • "paths": {
    • // ...
    • "exceljs": [
    • "node_modules/exceljs/dist/exceljs.min.js"
    • ]
    • }
    • }
    • }
  2. Enable the export UI
    Set the export.enabled property to true:

    app.component.html
    app.component.ts
    app.module.ts
    • <dx-pivot-grid ... >
    • <dxo-export [enabled]="true"></dxo-export>
    • </dx-pivot-grid>
    • import { Component } from '@angular/core';
    •  
    • @Component({
    • selector: 'app-root',
    • templateUrl: './app.component.html',
    • styleUrls: ['./app.component.css']
    • })
    • export class AppComponent {
    • // ...
    • }
    • import { BrowserModule } from '@angular/platform-browser';
    • import { NgModule } from '@angular/core';
    • import { AppComponent } from './app.component';
    •  
    • import { DxPivotGridModule } from 'devextreme-angular';
    •  
    • @NgModule({
    • declarations: [
    • AppComponent
    • ],
    • imports: [
    • BrowserModule,
    • DxPivotGridModule
    • ],
    • providers: [ ],
    • bootstrap: [AppComponent]
    • })
    • export class AppModule { }
  3. Export the PivotGrid
    Implement the onExporting handler and call the exportPivotGrid(options) method in it. In the code below, this method exports the PivotGrid as is, but you can use PivotGridExportOptions to configure export settings, including cell customization. The PivotGrid is exported to an Excel worksheet that is created using the ExcelJS API. To save the Excel document, call the FileSaver's saveAs method.

    app.component.html
    app.component.ts
    app.module.ts
    • <dx-pivot-grid ...
    • (onExporting)="onExporting($event)">
    • <dxo-export [enabled]="true"></dxo-export>
    • </dx-pivot-grid>
    • import { Component } from '@angular/core';
    • import { exportPivotGrid } from 'devextreme/excel_exporter';
    • import { Workbook } from 'exceljs';
    • import saveAs from 'file-saver';
    •  
    • @Component({
    • selector: 'app-root',
    • templateUrl: './app.component.html',
    • styleUrls: ['./app.component.css']
    • })
    • export class AppComponent {
    • onExporting(e) {
    • const workbook = new Workbook();
    • const worksheet = workbook.addWorksheet('Main sheet');
    • exportPivotGrid({
    • component: e.component,
    • worksheet: worksheet,
    • customizeCell: function(options) {
    • const excelCell = options;
    • excelCell.font = { name: 'Arial', size: 12 };
    • excelCell.alignment = { horizontal: 'left' };
    • }
    • }).then(function() {
    • workbook.xlsx.writeBuffer()
    • .then(function(buffer: BlobPart) {
    • saveAs(new Blob([buffer], { type: 'application/octet-stream' }), 'PivotGrid.xlsx');
    • });
    • });
    • }
    • }
    • import { BrowserModule } from '@angular/platform-browser';
    • import { NgModule } from '@angular/core';
    • import { AppComponent } from './app.component';
    • import { DxPivotGridModule } from 'devextreme-angular';
    •  
    • @NgModule({
    • declarations: [
    • AppComponent
    • ],
    • imports: [
    • BrowserModule,
    • DxPivotGridModule
    • ],
    • providers: [ ],
    • bootstrap: [AppComponent]
    • })
    • export class AppModule { }

The following restrictions apply when users export PivotGrid:

  • Only XLSX files are supported out of the box. To export PivotGrid to CSV, call the exportPivotGrid(options) method as shown in the following ticket: Export PivotGrid into CSV file.
  • Only visible rows and columns are exported.

enabled

Enables client-side exporting.

Type:

Boolean

Default Value: false