IFlexGridDrawSettings Interface

File
wijmo.grid.pdf.js
Module
wijmo.grid.pdf

Represents the settings used by the draw and drawToPosition methods.

Properties

Properties

customCellContent

Indicates whether custom cell content and style should be evaluated and exported. If set to true then export logic will retrieve cell content using cell.textContent property, and cell style using getComputedStyle(cell). Default is 'undefined' (i.e. false).

Type
boolean

embeddedFonts

Represents an array of custom fonts that will be embedded into the document.

This sample illustrates how to setup the FlexGridPdfConverter to use two custom fonts, Cuprum-Bold.ttf and Cuprum-Regular.ttf. The first one is applied to the header cells only, while the second one is applied to all the remaining cells.

wijmo.grid.pdf.FlexGridPdfConverter.export(flex, fileName, {
   embeddedFonts: [{
      source: 'resources/ttf/Cuprum-Bold.ttf',
      name: 'cuprum',
      style: 'normal',
      weight: 'bold'
   }, {
      source: 'resources/ttf/Cuprum-Regular.ttf',
      name: 'cuprum',
      style: 'normal',
      weight: 'normal'
   }],
   styles: {
      cellStyle: {
         font: {
            family: 'cuprum'
         }
      },
      headerCellStyle: {
         font: {
            weight: 'bold'
         }
      }
   }
});
Type
IPdfFontFile[]

exportMode

Determines the export mode.

Type
ExportMode

formatItem

An optional callback function called for every exported cell that allows to perform transformations of exported cell value and style, or perform a custom drawing.

The function accepts the PdfFormatItemEventArgs class instance as the first argument.

In case of custom drawing the cancel property should be set to true to cancel the default cell content drawing, and the cancelBorders property should be set to true to cancel the default cell borders drawing.

wijmo.grid.pdf.FlexGridPdfConverter.export(flex, fileName, {
   formatItem: function(args) {

       // Change the background color of the regular cells of "Country" column.
       if (args.panel.cellType === wijmo.grid.CellType.Cell && args.panel.columns[args.col].binding === "country") {
           args.style.backgroundColor = 'blue';
       }
   }
});
Type
Function

maxPages

Determines the maximum number of pages to export.

Type
number

recalculateStarWidths

Indicates whether star-sized columns widths should be recalculated against the PDF page width instead of using the grid's width.

Type
boolean

repeatMergedValuesAcrossPages

Indicates whether merged values should be repeated across pages when the merged range is split on multiple pages.

Type
boolean

styles

Represents the look and feel of an exported FlexGrid.

Type
IFlexGridStyle