Your search did not match any results.
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.

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.

Backend API
Copy to CodeSandBox
Apply
Reset
<dx-data-grid id="gridContainer" [dataSource]="companies" keyExpr="ID" [showBorders]="true" (onExporting)="onExporting($event)" > <dxo-export [enabled]="true" [formats]="['pdf']"></dxo-export> <dxo-group-panel [visible]="true"></dxo-group-panel> <dxo-grouping [autoExpandAll]="true"></dxo-grouping> <dxi-sort-by-group-summary-info summaryItem="count" ></dxi-sort-by-group-summary-info> <dxi-column dataField="Name" [width]="190"></dxi-column> <dxi-column dataField="Address" [width]="200"></dxi-column> <dxi-column dataField="City"></dxi-column> <dxi-column dataField="State" [groupIndex]="0"></dxi-column> <dxi-column dataField="Phone" [format]="phoneNumberFormat"></dxi-column> <dxi-column dataField="Website" caption="" alignment="center" [width]="100" cellTemplate="cellTemplate" ></dxi-column> <div *dxTemplate="let cell of 'cellTemplate'"> <a href="{{ cell.text }}" target="_blank">Website</a> </div> <dxo-summary> <dxi-total-item column="Name" summaryType="count" displayFormat="Total count: {0}" ></dxi-total-item> </dxo-summary> </dx-data-grid>
import { NgModule, Component, enableProdMode, } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; import { DxDataGridModule } from 'devextreme-angular'; import { exportDataGrid } from 'devextreme/pdf_exporter'; import { jsPDF } from 'jspdf'; import { Service, Company } from './app.service'; if (!/localhost/.test(document.location.host)) { enableProdMode(); } @Component({ selector: 'demo-app', templateUrl: 'app/app.component.html', styleUrls: ['app/app.component.css'], providers: [Service], }) export class AppComponent { companies: Company[]; constructor(private service: Service) { this.companies = service.getCompanies(); } onExporting(e) { const doc = new jsPDF(); exportDataGrid({ jsPDFDocument: doc, component: e.component, columnWidths: [40, 40, 30, 30, 40], customizeCell({ gridCell, pdfCell }) { 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 (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'); }); } phoneNumberFormat(value) { const USNumber = value.match(/(\d{3})(\d{3})(\d{4})/); return `(${USNumber[1]}) ${USNumber[2]}-${USNumber[3]}`; } } @NgModule({ imports: [ BrowserModule, DxDataGridModule, ], declarations: [AppComponent], bootstrap: [AppComponent], }) export class AppModule { } platformBrowserDynamic().bootstrapModule(AppModule);
#gridContainer { height: 436px; }
import { Injectable } from '@angular/core'; export class Company { ID: number; Name: string; Address: string; City: string; State: string; Zipcode: number; Phone: string; Fax: string; Website: string; } 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.com', }, { 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.com', }, { 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.com', }, { 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.com', }, { 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.com', }, { ID: 6, Name: 'Walters', Address: '200 Wilmot Rd', City: 'Deerfield', State: 'Illinois', Zipcode: 60015, Phone: '8479402500', Fax: '(847) 940-2501', Website: 'http://nowebsitewalters.com', }, { ID: 7, Name: 'StereoShack', Address: '400 Commerce S', City: 'Fort Worth', State: 'Texas', Zipcode: 76102, Phone: '8178200741', Fax: '(817) 820-0742', Website: 'http://nowebsiteshack.com', }, { 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.com', }, { 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.com', }, { ID: 10, Name: 'ElectrixMax', Address: '263 Shuman Blvd', City: 'Naperville', State: 'Illinois', Zipcode: 60563, Phone: '6304387800', Fax: '(630) 438-7801', Website: 'http://nowebsiteelectrixmax.com', }, { ID: 11, Name: 'Video Emporium', Address: '1201 Elm Street', City: 'Dallas', State: 'Texas', Zipcode: 75270, Phone: '2148543000', Fax: '(214) 854-3001', Website: 'http://nowebsitevideoemporium.com', }, { 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.com', }]; @Injectable() export class Service { getCompanies() { return companies; } }
// In real applications, you should not transpile code in the browser. // You can see how to create your own application with Angular and DevExtreme here: // https://js.devexpress.com/Documentation/Guide/Angular_Components/Getting_Started/Create_a_DevExtreme_Application/ window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, }, meta: { 'typescript': { 'exports': 'ts', }, 'devextreme/localization.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', '@angular/core': 'npm:@angular/core@12.2.17', '@angular/platform-browser': 'npm:@angular/platform-browser@12.2.17', '@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic@12.2.17', '@angular/forms': 'npm:@angular/forms@12.2.17', '@angular/common': 'npm:@angular/common@12.2.17', '@angular/compiler': 'npm:@angular/compiler@12.2.17', 'tslib': 'npm:tslib@2.3.1/tslib.js', 'rxjs': 'npm:rxjs@7.5.3/dist/bundles/rxjs.umd.js', 'rxjs/operators': 'npm:rxjs@7.5.3/dist/cjs/operators/index.js', 'fflate': 'npm:fflate@0.4.8/esm/browser.js', 'jspdf': 'npm:jspdf@2.5.1/dist/jspdf.umd.min.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.0/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@22.2.6/cjs', 'devextreme/bundles/dx.all': 'npm:devextreme@22.2.6/bundles/dx.all.js', 'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.5.20/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.1.72', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.43', 'devextreme-angular': 'npm:devextreme-angular@22.2.6', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.11', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.4/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js', }, packages: { 'app': { main: './app.component.ts', defaultExtension: 'ts', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, 'rxjs': { defaultExtension: 'js', }, 'rxjs/operators': { defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.11/inferno/package.json', 'npm:@angular/*/package.json', 'npm:@angular/common@12.2.17/*/package.json', 'npm:rxjs@7.5.3/package.json', 'npm:rxjs@7.5.3/operators/package.json', 'npm:devextreme-angular@22.2.6/*/package.json', 'npm:devextreme-angular@22.2.6/ui/*/package.json', 'npm:devextreme-angular@22.2.6/package.json', 'npm:devexpress-diagram@2.1.72/package.json', 'npm:devexpress-gantt@4.1.43/package.json', ], }; System.config(window.config);
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <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=1.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/22.2.6/css/dx.light.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/zone.js@0.13.0/dist/zone.js"></script> <script src="https://unpkg.com/reflect-metadata@0.1.13/Reflect.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script src="config.js"></script> <script> System.import("app").catch(console.error.bind(console)); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <demo-app>Loading...</demo-app> </div> </body> </html>