jQuery/JS Common - Utils - excelExporter

An object that serves as a namespace for the methods that export DevExtreme UI components to Excel.

exportDataGrid(options)

Exports grid data to Excel.

Module: excel_exporter
Parameters:

Export settings.

Return Value:

Promise<CellRange> (jQuery or native)

A Promise that is resolved with an object that contains the coordinates of the first and last cells.

This method requires ExcelJS v4+ to export data and FileSaver 2.0.1+ to save files.

You can call this method at any point in your application. In the example below, this method is called in the onExporting function that is executed before data is exported. The cancel parameter is enabled to prevent the built-in export. As a result, the DataGrid is exported to a single worksheet.

JavaScript
HTML
  • $('#gridContainer').dxDataGrid({
  • export: {
  • enabled: true
  • },
  • onExporting: function(e) {
  • const workbook = new ExcelJS.Workbook();
  • const worksheet = workbook.addWorksheet('Main sheet');
  •  
  • DevExpress.excelExporter.exportDataGrid({
  • worksheet: worksheet,
  • component: e.component
  • }).then(function() {
  • workbook.xlsx.writeBuffer().then(function(buffer) {
  • saveAs(new Blob([buffer], { type: 'application/octet-stream' }), 'DataGrid.xlsx');
  • });
  • });
  • e.cancel = true;
  • }
  • });
  • <head>
  • <!-- ... -->
  • <script src="https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/7.4.0/polyfill.min.js"></script>
  • <script src="https://cdnjs.cloudflare.com/ajax/libs/exceljs/4.1.1/exceljs.min.js"></script>
  • <script src="https://cdnjs.cloudflare.com/ajax/libs/FileSaver.js/2.0.1/FileSaver.min.js"></script>
  • <!-- reference the DevExtreme sources here -->
  • </head>

View Demo

See Also