jQuery/JS Common - Object Structures - PdfCell
An object that configures export to PDF settings in a DataGrid cell.
import { Cell } from "devextreme/common/export/pdf"
Type:
The customDrawCell and customizeCell functions use this object.
index.js
- $(function(){
- $('#exportButton').dxButton({
- // ...
- onClick: function() {
- const doc = new jsPDF();
- DevExpress.pdfExporter.exportDataGrid({
- jsPDFDocument: doc,
- component: dataGrid,
- customizeCell: function(options) {
- const { gridCell, pdfCell } = options;
- if(gridCell.rowType === 'data') {
- pdfCell.font = { size: 20 };
- }
- }
- }).then(function() {
- doc.save('Customers.pdf');
- });
- }
- });
- const dataGrid = $('#gridContainer').dxDataGrid({
- // ...
- }).dxDataGrid('instance');
- });
borderWidth
Type:
Default Value: 0.5
Uses the measure units that are specified in the constructor of the jsPDFDocument object.
drawBottomBorder
Type:
index.js
- $(function(){
- $('#exportButton').dxButton({
- // ...
- onClick: function() {
- const doc = new jsPDF();
- DevExpress.pdfExporter.exportDataGrid({
- jsPDFDocument: doc,
- component: dataGrid,
- customizeCell: function(options) {
- const { gridCell, pdfCell } = options;
- if(gridCell.rowType === 'data') {
- pdfCell.drawBottomBorder = false;
- }
- }
- }).then(function() {
- doc.save('Customers.pdf');
- });
- }
- });
- const dataGrid = $('#gridContainer').dxDataGrid({
- // ...
- }).dxDataGrid('instance');
- });
drawLeftBorder
Type:
index.js
- $(function(){
- $('#exportButton').dxButton({
- // ...
- onClick: function() {
- const doc = new jsPDF();
- DevExpress.pdfExporter.exportDataGrid({
- jsPDFDocument: doc,
- component: dataGrid,
- customizeCell: function(options) {
- const { gridCell, pdfCell } = options;
- if(gridCell.rowType === 'data') {
- pdfCell.drawLeftBorder = false;
- }
- }
- }).then(function() {
- doc.save('Customers.pdf');
- });
- }
- });
- const dataGrid = $('#gridContainer').dxDataGrid({
- // ...
- }).dxDataGrid('instance');
- });
drawRightBorder
Type:
index.js
- $(function(){
- $('#exportButton').dxButton({
- // ...
- onClick: function() {
- const doc = new jsPDF();
- DevExpress.pdfExporter.exportDataGrid({
- jsPDFDocument: doc,
- component: dataGrid,
- customizeCell: function(options) {
- const { gridCell, pdfCell } = options;
- if(gridCell.rowType === 'data') {
- pdfCell.drawRightBorder = false;
- }
- }
- }).then(function() {
- doc.save('Customers.pdf');
- });
- }
- });
- const dataGrid = $('#gridContainer').dxDataGrid({
- // ...
- }).dxDataGrid('instance');
- });
drawTopBorder
Type:
index.js
- $(function(){
- $('#exportButton').dxButton({
- // ...
- onClick: function() {
- const doc = new jsPDF();
- DevExpress.pdfExporter.exportDataGrid({
- jsPDFDocument: doc,
- component: dataGrid,
- customizeCell: function(options) {
- const { gridCell, pdfCell } = options;
- if(gridCell.rowType === 'data') {
- pdfCell.drawTopBorder = false;
- }
- }
- }).then(function() {
- doc.save('Customers.pdf');
- });
- }
- });
- const dataGrid = $('#gridContainer').dxDataGrid({
- // ...
- }).dxDataGrid('instance');
- });
font
Type:
index.js
- $(function(){
- $('#exportButton').dxButton({
- // ...
- onClick: function() {
- const doc = new jsPDF();
- DevExpress.pdfExporter.exportDataGrid({
- jsPDFDocument: doc,
- component: dataGrid,
- customizeCell: function(options) {
- const { gridCell, pdfCell } = options;
- if(gridCell.rowType === 'data') {
- pdfCell.font = { size: 20, style: 'bold', name: 'Arial' };
- }
- }
- }).then(function() {
- doc.save('Customers.pdf');
- });
- }
- });
- const dataGrid = $('#gridContainer').dxDataGrid({
- // ...
- }).dxDataGrid('instance');
- });
horizontalAlign
Type:
Accepted Values: 'left' | 'center' | 'right'
The default alignment of the content depends on the dataType.
dataType | alignment |
---|---|
'number' | 'right' |
'boolean' | 'center' |
'string' | 'left' |
'date' | 'left' |
'datetime' | 'left' |
padding
Type:
Uses the measure units which are specified in the constructor of the jsPDFDocument object.
index.js
- $(function(){
- $('#exportButton').dxButton({
- // ...
- onClick: function() {
- const doc = new jsPDF();
- DevExpress.pdfExporter.exportDataGrid({
- jsPDFDocument: doc,
- component: dataGrid,
- customizeCell: function(options) {
- const { gridCell, pdfCell } = options;
- if(gridCell.rowType === 'data') {
- pdfCell.padding = { top: 10, right: 10, bottom: 10, left: 10 };
- }
- }
- }).then(function() {
- doc.save('Customers.pdf');
- });
- }
- });
- const dataGrid = $('#gridContainer').dxDataGrid({
- // ...
- }).dxDataGrid('instance');
- });
wordWrapEnabled
Type:
The default value depends on the value of the DataGrid's wordWrapEnabled property.
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.