Vue 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:
- <template>
- <div>
- <DxButton ...
- @click="exportGrid()"
- />
- <DxDataGrid ...
- :ref="dataGridRef">
- <!-- ... -->
- </DxDataGrid>
- </div>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import DxDataGrid from 'devextreme-vue/data-grid';
- import DxButton from 'devextreme-vue/button';
- import { jsPDF } from 'jspdf';
- import { exportDataGrid as exportDataGridToPdf } from 'devextreme/pdf_exporter';
- const dataGridRef = 'dataGrid';
- export default {
- components: {
- DxDataGrid,
- DxButton
- },
- data() {
- return {
- dataGridRef
- };
- },
- computed: {
- dataGrid: function() {
- return this.$refs[dataGridRef].instance;
- }
- },
- methods: {
- exportGrid() {
- const doc = new jsPDF();
- exportDataGridToPdf({
- jsPDFDocument: doc,
- component: this.dataGrid
- }).then(() => {
- doc.save('Customers.pdf');
- });
- }
- }
- }
- </script>
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:
- <template>
- <DxGantt ... >
- <DxToolbar>
- <!-- ... -->
- <DxItem
- :options="exportButtonOptions"
- widget="dxButton"
- />
- </DxToolbar>
- <!-- ... -->
- </DxGantt>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import 'devexpress-gantt/dist/dx-gantt.css';
- import {
- DxGantt,
- DxToolbar,
- DxItem
- // ...
- } from 'devextreme-vue/gantt';
- import { jsPDF } from 'jspdf';
- import 'jspdf-autotable';
- import { exportGantt as exportGanttToPdf } from 'devextreme/pdf_exporter';
- const ganttRef = 'gantt';
- export default {
- components: {
- DxGantt,
- DxToolbar,
- DxItem
- // ...
- },
- data() {
- return {
- exportButtonOptions: {
- hint: 'Export to PDF',
- icon: 'exportpdf',
- stylingMode: 'text',
- onClick: () => {
- this.exportGantt();
- },
- },
- };
- },
- computed: {
- gantt() {
- return this.$refs[ganttRef].instance;
- },
- },
- methods: {
- exportGantt() {
- exportGanttToPdf({
- component: this.gantt,
- createDocumentMethod: (args) => new jsPDF(args),
- format: 'a4',
- exportMode: 'all',
- dateRange: 'visible',
- }).then((doc) => doc.save('gantt.pdf'));
- },
- },
- };
- </script>
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.