Vue Data Grid - Cell Customization

DataGrid allows you to modify cell style settings and custom paint cells in a PDF document.

Use the customizeCell function to customize the appearance settings of DataGrid cells in a PDF document. For example, you can change the text alignment and the background color of cells. The following function parameters are available:

gridCell
Contains information about the source DataGrid cell.
pdfCell
Contains settings applied to a cell in a PDF document.

Backend API

<template> <div> <DxDataGrid id="gridContainer" :key-expr="'ID'" :data-source="companies" :width="'100%'" :show-borders="true" @exporting="onExporting" > <DxExport :enabled="true" :formats="['pdf']" /> <DxGroupPanel :visible="true"/> <DxGrouping :auto-expand-all="true"/> <DxSortByGroupSummaryInfo summary-item="count"/> <DxColumn data-field="Name" :width="190" /> <DxColumn data-field="Address" :width="200" /> <DxColumn data-field="City"/> <DxColumn data-field="State" :group-index="0" /> <DxColumn data-field="Phone" :format="phoneNumberFormat" /> <DxColumn data-field="Website" alignment="center" :width="100" cell-template="grid-cell" /> <template #grid-cell="{ data }"> <a :href="data.text" target="_blank" > Website </a> </template> /> <DxSummary> <DxTotalItem column="Name" summary-type="count" display-format="Total count: {0}" /> </DxSummary> </DxDataGrid> </div> </template> <script setup lang="ts"> import { DxDataGrid, DxColumn, DxGrouping, DxGroupPanel, DxExport, DxSummary, DxSortByGroupSummaryInfo, DxTotalItem, type DxDataGridTypes, } from 'devextreme-vue/data-grid'; import { exportDataGrid, type DataGridCell, type Cell as PdfCell } from 'devextreme-vue/common/export/pdf'; import { jsPDF } from 'jspdf'; import { companies } from './data.ts'; const onExporting = (e: DxDataGridTypes.ExportingEvent) => { const doc = new jsPDF(); exportDataGrid({ jsPDFDocument: doc, component: e.component, columnWidths: [40, 40, 30, 30, 40], customizeCell({ gridCell, pdfCell }: { gridCell?: DataGridCell, pdfCell?: PdfCell }) { if (!(pdfCell?.font && pdfCell.text)) { return; } if (gridCell?.rowType === 'data' && gridCell?.column?.dataField === 'Phone') { pdfCell.text = pdfCell.text.replace(/(\d{3})(\d{3})(\d{4})/, '($1) $2-$3'); } else if (gridCell?.rowType === 'group') { pdfCell.backgroundColor = '#BEDFE6'; } else if (gridCell?.rowType === 'totalFooter') { pdfCell.font.style = 'italic'; } }, customDrawCell(options) { const { gridCell, pdfCell } = options; if (options.rect && pdfCell?.text && pdfCell.padding?.left && gridCell?.rowType === 'data' && gridCell.column?.dataField === 'Website') { options.cancel = true; doc.setFontSize(11); doc.setTextColor('#0000FF'); const textHeight = doc.getTextDimensions(pdfCell.text).h; doc.textWithLink('website', options.rect.x + pdfCell.padding.left, options.rect.y + options.rect.h / 2 + textHeight / 2, { url: pdfCell.text }); } }, }).then(() => { doc.save('Companies.pdf'); }); }; const phoneNumberFormat = (value: string) => { const USNumber = value.match(/(\d{3})(\d{3})(\d{4})/)!; return `(${USNumber[1]}) ${USNumber[2]}-${USNumber[3]}`; }; </script> <style> #gridContainer { height: 436px; } </style>

export type Company = { ID: number; Name: string; Address: string; City: string; State: string; Zipcode: number; Phone: string; Fax: string; Website: string; }; export const companies: Company[] = [{ ID: 1, Name: 'Super Mart of the West', Address: '702 SW 8th Street', City: 'Bentonville', State: 'Arkansas', Zipcode: 72716, Phone: '8005552797', Fax: '(800) 555-2171', Website: 'http://nowebsitesupermart.dx', }, { ID: 2, Name: 'Electronics Depot', Address: '2455 Paces Ferry Road NW', City: 'Atlanta', State: 'Georgia', Zipcode: 30339, Phone: '8005953232', Fax: '(800) 595-3231', Website: 'http://nowebsitedepot.dx', }, { ID: 3, Name: 'K&S Music', Address: '1000 Nicllet Mall', City: 'Minneapolis', State: 'Minnesota', Zipcode: 55403, Phone: '6123046073', Fax: '(612) 304-6074', Website: 'http://nowebsitemusic.dx', }, { ID: 4, Name: 'Tom\'s Club', Address: '999 Lake Drive', City: 'Issaquah', State: 'Washington', Zipcode: 98027, Phone: '8009552292', Fax: '(800) 955-2293', Website: 'http://nowebsitetomsclub.dx', }, { ID: 5, Name: 'E-Mart', Address: '3333 Beverly Rd', City: 'Hoffman Estates', State: 'Illinois', Zipcode: 60179, Phone: '8472862500', Fax: '(847) 286-2501', Website: 'http://nowebsiteemart.dx', }, { ID: 6, Name: 'Walters', Address: '200 Wilmot Rd', City: 'Deerfield', State: 'Illinois', Zipcode: 60015, Phone: '8479402500', Fax: '(847) 940-2501', Website: 'http://nowebsitewalters.dx', }, { ID: 7, Name: 'StereoShack', Address: '400 Commerce S', City: 'Fort Worth', State: 'Texas', Zipcode: 76102, Phone: '8178200741', Fax: '(817) 820-0742', Website: 'http://nowebsiteshack.dx', }, { ID: 8, Name: 'Circuit Town', Address: '2200 Kensington Court', City: 'Oak Brook', State: 'Illinois', Zipcode: 60523, Phone: '8009552929', Fax: '(800) 955-9392', Website: 'http://nowebsitecircuittown.dx', }, { ID: 9, Name: 'Premier Buy', Address: '7601 Penn Avenue South', City: 'Richfield', State: 'Minnesota', Zipcode: 55423, Phone: '6122911000', Fax: '(612) 291-2001', Website: 'http://nowebsitepremierbuy.dx', }, { ID: 10, Name: 'ElectrixMax', Address: '263 Shuman Blvd', City: 'Naperville', State: 'Illinois', Zipcode: 60563, Phone: '6304387800', Fax: '(630) 438-7801', Website: 'http://nowebsiteelectrixmax.dx', }, { ID: 11, Name: 'Video Emporium', Address: '1201 Elm Street', City: 'Dallas', State: 'Texas', Zipcode: 75270, Phone: '2148543000', Fax: '(214) 854-3001', Website: 'http://nowebsitevideoemporium.dx', }, { ID: 12, Name: 'Screen Shop', Address: '1000 Lowes Blvd', City: 'Mooresville', State: 'North Carolina', Zipcode: 28117, Phone: '8004456937', Fax: '(800) 445-6938', Website: 'http://nowebsitescreenshop.dx', }];

import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');

<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/26.1.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="./bundle.css" /> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> <script src="bundles/vendor/vue.vendor.js"></script> <script src="./bundle.js"></script> </body> </html>

In this demo, the customizeCell function changes the following elements:

Background color and font weight of group row cells
Font style of a footer cell

The customDrawCell function allows you to draw cells in a PDF document. The following parameters are available when you use this function:

doc
An instance of the jsPDFDocument object.
rect
A cell’s bounds.
gridCell
Contains information about the source DataGrid cell.
pdfCell
Contains settings applied to a cell in a PDF document.
cancel
Set this parameter to true to prevent default painting logic.

This demo uses the customDrawCell function to paint cells in the "Website" column.