jQuery/JS Common - Utils - pdfExporter
exportDataGrid(options)
A Promise that resolves when grid data is ready for export. If you use jQuery, the return value is a jQuery.Promise. In other cases, it's a native JavaScript Promise.
This method uses jsPDF v2.3.1+ to export data and create PDF files.
If you use jQuery, store links to the jsPDF library within the <head>
tag. If you use Angular, Vue, or React, install the library with the following command:
- npm install jspdf
You can call this method at any point in your application.
Warning: You need to perform extra steps to generate PDFs with non-ASCII characters. See the PDF Export guide for more information.
In the following example, the onClick handler of a standalone button fires this method:
- $(function(){
- $('#exportButton').dxButton({
- // ...
- onClick: function() {
- const doc = new jsPDF();
- DevExpress.pdfExporter.exportDataGrid({
- jsPDFDocument: doc,
- component: dataGrid
- }).then(function() {
- doc.save('Customers.pdf');
- });
- }
- });
- const dataGrid = $('#gridContainer').dxDataGrid({
- // ...
- }).dxDataGrid('instance');
- });
- <head>
- <!-- ... -->
- <script src="https://cdnjs.cloudflare.com/ajax/libs/jspdf/2.0.0/jspdf.umd.min.js"></script>
- <!-- DevExtreme sources are referenced here -->
- </head>
exportGantt(options)
A Promise that resolves when the Gantt data is ready for export. It is a native Promise or a jQuery.Promise when you use jQuery.
This method uses jsPDF v2.3.1+ to generate PDF files, and the jsPDF-AutoTable plugin to create tables within the PDF.
Warning: You need to perform extra steps to generate PDFs with non-ASCII characters. See the PDF Export guide. for more information.
In the following example, the onClick handler of a standalone toolbar item fires this method:
- const ganttInstance = $('#gantt').dxGantt({
- toolbar: {
- items: [
- // ...
- {
- widget: 'dxButton',
- options: {
- icon: 'exportpdf',
- hint: 'Export to PDF',
- stylingMode: 'text',
- onClick() {
- exportGantt();
- },
- },
- },
- ],
- },
- }).dxGantt('instance');
- function exportGantt() {
- DevExpress.pdfExporter.exportGantt({
- component: ganttInstance,
- createDocumentMethod: (args) => new jsPDF(args),
- format: 'a4',
- exportMode: 'all',
- dateRange: 'visible'
- },
- ).then((doc) => {
- doc.save('gantt.pdf');
- });
- }
The following code snippet illustrates how to process the PDF document when the export is complete:
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.exportToPdf({
- format: "A4",
- landscape: true,
- exportMode: "chart",
- dateRange: "visible"
- }).then(function(doc) {
- doc.addPage();
- // your code
- doc.save('customDoc.pdf');
- });
To print the exported PDF document, call the autoPrint method:
- var gantt = $("#ganttContainer").dxGantt("instance");
- gantt.exportToPdf({
- format: "A4",
- landscape: true,
- exportMode: "chart",
- dateRange: "visible"
- }).then(function(doc) {
- doc.autoPrint();
- window.open(doc.output('your_url'), '_blank');
- });
If you have technical questions, please create a support ticket in the DevExpress Support Center.