This page documents the PDF Export API and interfaces.
Grid Properties Copy Link
A default configuration object used to export to PDF. |
Prevents the user from exporting the grid to PDF. |
API Methods Copy Link
Downloads a PDF export of the grid's data. |
Similar to exportDataAsPdf, except instead of downloading a file, it will return a Blob to be processed by the user. |
Interfaces Copy Link
PdfCell Copy Link
Properties available on the PdfCell interface.
The data that will be added to the cell. |
The number of cells to span across (1 means span 2 columns). |
Optional styling for the cell.
|
PdfCellData Copy Link
Properties available on the PdfCellData interface.
The value of the cell. |
External URI opened when the exported cell text is selected. |
Image rendered alongside the cell value. |
PdfCellHyperlinkCallbackParams Copy Link
Properties available on the PdfCellHyperlinkCallbackParams<TData = any, TContext = any> interface.
The final text exported for the cell. |
The 1-based index of the current exported row. |
The row node for the exported cell. |
The current column. |
The grid api. |
Application context as set on gridOptions.context. |
PdfCellStyle Copy Link
Properties available on the PdfCellStyle interface.
Background colour.
|
Border colour.
|
Border width in points. Defaults to 1 when borderColor is set, otherwise 0.
|
Padding inside the cell in points. A number applies to all sides.
|
Horizontal alignment for the cell text.
|
Whether text should wrap onto multiple lines. Wrapped content increases the row height as required. |
Whether explicit line breaks should be preserved. |
Whether repeated, leading and trailing spaces should be preserved when text wraps. |
Maximum number of rendered text lines.
|
How text exceeding the available width, height or line limit is indicated. |
Font size in points.
|
Font family.
|
Font weight. When omitted, the weight from the resolved font family is preserved.
|
Font style. |
Text direction. auto uses the first strong directional character. When omitted, the export-level direction is used. Text direction does not change exported column order.
|
BCP 47 language tag used when selecting language-specific OpenType features. When omitted, the export-level language is used.
|
Text colour.
|
Distance between text baselines in points. Defaults to the natural line height from the resolved font metrics, with a minimum of fontSize.
|
PdfCellStyleCallbackParams Copy Link
Properties available on the PdfCellStyleCallbackParams<TData = any, TContext = any> interface.
The exported element type currently being styled. |
The row node for the exported cell. |
The current column. |
1-based index of the current exported row.
|
The current value for the exported element.
|
The grid api. |
Application context as set on gridOptions.context. |
PdfColors Copy Link
Properties available on the PdfColors interface.
Background colour for the PDF page. |
Background colour for body rows. |
Alternate background colour for odd body rows. |
Text colour for body rows. |
Background colour for header rows. |
Text colour for header rows. |
Border colour for cell outlines. |
PdfDocumentHeadingStyle Copy Link
Properties available on the PdfDocumentHeadingStyle interface.
Margin around the document heading in points. A number applies to all sides.
|
Background colour.
|
Border colour.
|
Border width in points. Defaults to 1 when borderColor is set, otherwise 0.
|
Padding inside the cell in points. A number applies to all sides.
|
Horizontal alignment for the cell text.
|
Whether text should wrap onto multiple lines. Wrapped content increases the row height as required. |
Whether explicit line breaks should be preserved. |
Whether repeated, leading and trailing spaces should be preserved when text wraps. |
Maximum number of rendered text lines.
|
How text exceeding the available width, height or line limit is indicated. |
Font size in points.
|
Font family.
|
Font weight. When omitted, the weight from the resolved font family is preserved.
|
Font style. |
Text direction. auto uses the first strong directional character. When omitted, the export-level direction is used. Text direction does not change exported column order.
|
BCP 47 language tag used when selecting language-specific OpenType features. When omitted, the export-level language is used.
|
Text colour.
|
Distance between text baselines in points. Defaults to the natural line height from the resolved font metrics, with a minimum of fontSize.
|
PdfExportParams Copy Link
Properties available on the PdfExportParams interface.
Custom static TrueType font families available to this export. Font data must be loaded by the application before export. |
BCP 47 language tag used for text shaping and PDF accessibility metadata. This can be overridden by individual cell styles.
|
Default text direction for the PDF document. When omitted, this inherits the grid's enableRtl setting. Individual PdfCellStyle.direction values take precedence for text. An export-level value of rtl also renders table columns in right-to-left order. |
The document title stored in the PDF metadata. When set, a visible title is rendered above the exported table.
|
Styling for the visible document title.
|
A visible subtitle rendered below the document title.
|
Styling for the visible document subtitle.
|
Set to true to render the document title and subtitle on a separate first page. The exported grid begins on the following page. |
Page header and footer content.
|
A text watermark rendered across the content of selected pages.
|
Override PDF colours. Any missing values fall back to the current theme.
|
Set to true to skip applying grid style definitions and callbacks (rowStyle, getRowStyle, colDef.cellStyle, colDef.headerStyle). Use this when you want to rely only on colors and theme defaults. |
Callback that allows overriding styles for rows, cells, row groups, headers and group headers during PDF export. Returned styles are merged after resolved grid styles and take precedence.
|
Callback that provides an external URI for an exported body cell. The returned URI is added to the PDF as a clickable link annotation.
|
Callback that provides an image for an exported body cell. Return an optional value to replace the exported cell text.
|
Page size, orientation and margins. |
Default style applied to every body cell, including custom content rows. Grid styles, row and cell styles, and processStyleCallback results override these values. When no style is provided, body cells use Helvetica at 10 points. |
Default style applied to header and group-header cells. Each unset property inherits from defaultCellStyle; values set here take precedence. If neither style sets fontSize, headers use 11 points. If no font weight is inherited or set, headers use the bold variant of the resolved body font. |
Controls exported column widths. Use auto to size from exported content, grid to use the current column width in the grid, a number for a width in points, or a callback for per-column control. Widths are proportionally reduced when their total exceeds the printable page width. |
Horizontal indentation in points for each row-group level. |
Height of body rows in points. If omitted, calculated from font size and padding. |
Height of header rows in points. If omitted, calculated from header font size and padding. |
Set to false to avoid repeating header rows on each page. |
Set to false to skip drawing cell borders. |
Content to put at the top of the exported sheet.
|
Content to put at the bottom of the exported sheet.
|
A callback function to return content to be inserted below a row in the export. |
Set to true to allow the contents of the Row Numbers column to be exported. |
String to use as the file name or a function that returns a string. |
The mimeType of the PDF file. |
If true, all columns will be exported in the order they appear in the columnDefs. When false only the columns currently being displayed will be exported. |
Provide a list (an array) of column keys or Column objects if you want to export specific columns.
|
Row node positions. |
Determines whether rows are exported before being filtered and sorted. |
Export only selected rows. |
Only export selected rows including other pages (only makes sense when using pagination). |
Set to true to exclude header column groups. |
Set to true if you don't want to export column headers. |
Set to true to skip row group headers if grouping rows. Only relevant when grouping rows. |
Set to true to suppress exporting rows pinned to the top of the grid. |
Set to true to suppress exporting rows pinned to the bottom of the grid. |
Set to true to omit the body copies of manually pinned rows. The rows in the pinned sections are still exported unless skipPinnedTop or skipPinnedBottom is enabled. |
The base source to use for getting cell values. 'data': values from the underlying row data 'batch': pending batch edit values (falls back to data if not in batch mode) 'edit': current editor values including live typing |
Apply the Show Values As transform (e.g. a percentage of a total) on top of the valueFrom base, so the export carries the displayed value for columns with an active mode. Columns without one export the base value. |
A callback function that will be invoked once per row in the grid. Return true to omit the row from the export.
|
A callback function invoked once per cell in the grid. Return a string value to be displayed in the export. For example this is useful for formatting date values.
|
A callback function invoked once per column. Return a string to be displayed in the column header.
|
A callback function invoked once per column group. Return a string to be displayed in the column group header. Note that column groups are exported by default, this option will not work with skipColumnGroupHeaders=true.
|
A callback function invoked once per row group. Return a string to be displayed in the group cell.
|
PdfFontFace Copy Link
Properties available on the PdfFontFace interface.
Static TrueType font data. |
Weight represented by this face. |
Style represented by this face. |
PdfFontFamilyDefinition Copy Link
Properties available on the PdfFontFamilyDefinition interface.
Family name used by PDF styles. |
Font faces available for this family. |
PdfGroupHeaderStyleCallbackParams Copy Link
Properties available on the PdfGroupHeaderStyleCallbackParams<TData = any, TContext = any> interface.
The exported element type currently being styled. |
The current column group. |
1-based index of the current exported row.
|
The current value for the exported element.
|
The grid api. |
Application context as set on gridOptions.context. |
PdfHeaderFooter Copy Link
Properties available on the PdfHeaderFooter interface.
Up to three header entries positioned left, centre, and right. |
Up to three footer entries positioned left, centre, and right. |
PdfHeaderFooterConfig Copy Link
Properties available on the PdfHeaderFooterConfig interface.
Header and footer configuration applied to every page unless overridden. |
Header and footer configuration applied to the first page. |
Header and footer configuration applied to even-numbered pages. |
PdfHeaderFooterImageContent Copy Link
Properties available on the PdfHeaderFooterImageContent interface.
Header or footer text. Supports &[Page], &[Pages], &[Date], and &[Time] placeholders.
|
Image rendered alongside the text. |
Position of the content within the printable page width. When omitted, array entries default to left, centre, and right in order.
|
Text styling for this entry. |
PdfHeaderFooterTextContent Copy Link
Properties available on the PdfHeaderFooterTextContent interface.
Header or footer text. Supports &[Page], &[Pages], &[Date], and &[Time] placeholders.
|
Image rendered alongside the text. |
Position of the content within the printable page width. When omitted, array entries default to left, centre, and right in order.
|
Text styling for this entry. |
PdfHeaderStyleCallbackParams Copy Link
Properties available on the PdfHeaderStyleCallbackParams<TData = any, TContext = any> interface.
The exported element type currently being styled. |
The current column. |
1-based index of the current exported row.
|
The current value for the exported element.
|
The grid api. |
Application context as set on gridOptions.context. |
PdfMargin Copy Link
Properties available on the PdfMargin interface.
Top margin in points. |
Right margin in points. |
Bottom margin in points. |
Left margin in points. |
PdfPageSetup Copy Link
Properties available on the PdfPageSetup interface.
The size of the PDF page. |
Page orientation. |
Page margins in points. A number applies to all sides. |
PdfRowStyleCallbackParams Copy Link
Properties available on the PdfRowStyleCallbackParams<TData = any, TContext = any> interface.
The exported element type currently being styled. |
The row node for the exported row. |
1-based index of the current exported row.
|
The current value for the exported element.
|
The grid api. |
Application context as set on gridOptions.context. |
PdfTextStyle Copy Link
Properties available on the PdfTextStyle interface.
Font size in points.
|
Font family.
|
Font weight. When omitted, the weight from the resolved font family is preserved.
|
Font style. |
Text direction. auto uses the first strong directional character. When omitted, the export-level direction is used. Text direction does not change exported column order.
|
BCP 47 language tag used when selecting language-specific OpenType features. When omitted, the export-level language is used.
|
Text colour.
|
Distance between text baselines in points. Defaults to the natural line height from the resolved font metrics, with a minimum of fontSize.
|
PdfWatermark Copy Link
Properties available on the PdfWatermark interface.
Text displayed diagonally across the exported page content. |
Text opacity from 0 (transparent) to 1 (opaque). |
Rotation in degrees. |
Pages on which the watermark is rendered. |
Text styling for the watermark. |