React Data GridExcel Export - Extra Content

Enterprise

Prepending and Appending Custom Content

The recommended way to prepend and append content, is by passing an array of ExcelCell objects to prependContent or appendContent. This ensures that the extra content is correctly escaped.

For compatibility with earlier versions of the Grid you can also pass a string, which will be inserted into the file without any processing. You are responsible for formatting the string correctly.

Note the following:

  • You can check and uncheck the checkboxes to add extra content before and after the grid via the prependContent and appendContent properties.

  • With prependContent=ExcelRow[] or appendContent=ExcelRow[], custom content will be inserted containing commas and quotes. These commas and quotes will be visible when opened in Excel because they have been escaped properly.

Export Cover Page

In addition to exporting the Grid in the Excel file, you can also provide additional content on a separate sheet of the Excel file. This can be useful when you'd like to add a cover page to provide your users additional details on the data in this file.

Extra content can also be added in the form of Headers and Footers of the exported Excel file. Please note that this header and footer content is only visible when printing or exporting from Excel to PDF.

You can set header and footer content via the headerFooterConfig: ExcelHeaderFooterConfig object. See it documented further below.

The header and footer object accepts the following placeholders:

  • &[Page]: Prints the current page number.
  • &[Pages]: Prints the total number of pages.
  • &[Date]: Prints the current date.
  • &[Time]: Prints the current time.
  • &[Tab]: Prints the current sheet name.
  • &[Path]: Prints the file path.
  • &[File]: Prints the file name.
  • &[Picture]: Adds an image to the Header or Footer, see more Adding Images to the Header or Footer.

In addition to exporting the Grid as an Excel file, you can also provide pictures on the Header or Footer of the Worksheet. This can be useful when you want to use images as watermark for example. Please note that the watermark image will only be visible in the header & footer view or when printing in Excel.

ExcelHeaderFooterConfig

Properties available on the ExcelHeaderFooterConfig interface.

The configuration for header and footer on every page.
The configuration for header and footer on the first page only.
The configuration for header and footer on even numbered pages only.

ExcelHeaderFooter

Properties available on the ExcelHeaderFooter interface. At least one of header or footer is required or both.

An array of maximum 3 items (Left, Center, Right), containing header configurations.
An array of maximum 3 items (Left, Center, Right), containing footer configurations.

ExcelHeaderFooterContent

Properties available on the ExcelHeaderFooterContent interface.

value required
string
The value of the text to be included in the header.
When value is &[Picture], this should be used as the referenced image.
position
'Left' | 'Center' | 'Right'
default: 'Left'
Configures where the text should be added: Left, Center or Right.
The font style of the header/footer value.

ExcelHeaderFooterImage

Properties available on the ExcelHeaderFooterImage interface.

width required
number
The width of the image in pixels.
height required
number
The height of the image in pixels.
id required
string
The image id. This field is required so the same image doesn't get imported multiple times.
base64 required
string
A base64 string that represents the image being imported.
imageType required
'jpg' | 'png' | 'gif'
The type of image being exported.
recolor
'Grayscale' | 'Black & White' | 'Washout'
Set this property to select a preset that changes the appearance of the image.
brightness
number
The brightness of the image between 0 and 100 (if recolor is used, this value will only be applied for Grayscale). Default 50
contrast
number
The contrast of the image between 0 and 100. (If recolor is used, this value will only be applied for Grayscale.). Default 50
altText
string
Alt Text for the image.

Next Up

Continue to the next section: Customising Content.