React Common - Utils - pdfExporter
exportDataGrid(options) CTP
Module: pdf_exporter
Parameters:
options:
A Promise that is resolved when the grid data is prepared for export. It is a native Promise or a jQuery.Promise when you use jQuery.
NOTE
This functionality is available as a community technology preview (CTP). Should you have any questions or suggestions prior to its official release, please create a new ticket in the DevExpress Support Center.
This method requires the jsPDF library to export data and the jsPDF-AutoTable plugin to create tables in exported files.
You can call this method at any point in your application. In this example, we call this method in a standalone button's onClick handler:
Installation command
App.js
- npm install jspdf jspdf-autotable
- import React from 'react';
- import 'devextreme/dist/css/dx.common.css';
- import 'devextreme/dist/css/dx.light.css';
- import DataGrid from 'devextreme-react/data-grid';
- import Button from 'devextreme-react/button';
- import { jsPDF } from 'jspdf';
- import 'jspdf-autotable';
- import { exportDataGrid as exportDataGridToPdf } from 'devextreme/pdf_exporter';
- export default function App() {
- const dataGridRef = useRef(null);
- function exportGrid() {
- const doc = new jsPDF();
- const dataGrid = dataGridRef.current.instance;
- exportDataGridToPdf({
- jsPDFDocument: doc,
- component: dataGrid
- }).then(() => {
- doc.save('Customers.pdf');
- });
- }
- return (
- <React.Fragment>
- <div>
- <Button ...
- onClick={exportGrid}
- />
- <DataGrid ...
- ref={dataGridRef}
- >
- {/* ... */}
- </DataGrid>
- </div>
- </React.Fragment>
- );
- }
Feel free to share topic-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you for the feedback!
If you have technical questions, please create a support ticket in the DevExpress Support Center.