JavaScript Data GridExcel Export API ReferenceEnterprise

excelStyles: ExcelStyle[];

interface ExcelStyle {
  // The id of the Excel Style, this should match a CSS cell class. 
  id: string;
  // Use this property to customise cell alignment properties. 
  alignment?: ExcelAlignment;
  // Use this property to customise cell borders. 
  borders?: ExcelBorders;
  // Use this property to specify the type of data being exported. 
  dataType?: ExcelDataType;
  // Use this property to customise the font used in the cell. 
  font?: ExcelFont;
  // Use this property to customise the cell background. 
  interior?: ExcelInterior;
  // Use this property to customise the cell value as a formatted number. 
  numberFormat?: ExcelNumberFormat;
  // Use this property to setup cell protection. 
  protection?: ExcelProtection;
}

function exportDataAsExcel(
    params?: ExcelExportParams
): void;

function getDataAsExcel(
    params?: ExcelExportParams
): string | Blob | undefined;

function getSheetDataForExcel(
    params?: ExcelExportParams
): string | undefined;

function exportMultipleSheetsAsExcel(
    params: ExcelExportMultipleSheetParams
): void;

interface ExcelExportMultipleSheetParams {
  // The author of the exported file.
  // Default: `AG Grid`
  author?: string;
  // Array of strings containing the raw data for Excel workbook sheets.
  // This property is only used when exporting to multiple sheets using `api.exportMultipleSheetsAsExcel()` and the data for each sheet is obtained by calling `api.getSheetDataForExcel()`.
  data: string[];
  // String to use as the file name.
  // Default: `export.xlsx`
  fileName?: string;
  // The default value for the font size of the Excel document.
  // Default: `11`
  fontSize?: number;
  // The mimeType of the Excel file.
  // Default: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
  mimeType?: string;
}

function getMultipleSheetsAsExcel(
    params: ExcelExportMultipleSheetParams
): Blob | undefined;

interface ExcelExportMultipleSheetParams {
  // The author of the exported file.
  // Default: `AG Grid`
  author?: string;
  // Array of strings containing the raw data for Excel workbook sheets.
  // This property is only used when exporting to multiple sheets using `api.exportMultipleSheetsAsExcel()` and the data for each sheet is obtained by calling `api.getSheetDataForExcel()`.
  data: string[];
  // String to use as the file name.
  // Default: `export.xlsx`
  fileName?: string;
  // The default value for the font size of the Excel document.
  // Default: `11`
  fontSize?: number;
  // The mimeType of the Excel file.
  // Default: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
  mimeType?: string;
}

columnWidth: number | ((params: ColumnWidthCallbackParams) => number);

interface ColumnWidthCallbackParams {
  column: Column | null;
  index: number;
}

headerRowHeight: number | ((params: RowHeightCallbackParams) => number);

interface RowHeightCallbackParams {
  rowIndex: number;
}

rowHeight: number | ((params: RowHeightCallbackParams) => number);

interface RowHeightCallbackParams {
  rowIndex: number;
}

margins: ExcelSheetMargin;

interface ExcelSheetMargin {
  // The sheet top margin.
  // Default: `0.75`
  top?: number;
  // The sheet right margin.
  // Default: `0.7`
  right?: number;
  // The sheet bottom margin.
  // Default: `0.75`
  bottom?: number;
  // The sheet left margin.
  // Default: `0.7`
  left?: number;
  // The sheet header margin.
  // Default: `0.3`
  header?: number;
  // The sheet footer margin.
  // Default: `0.3`
  footer?: number;
}

pageSetup: ExcelSheetPageSetup;

interface ExcelSheetPageSetup {
  // Use this property to change the print orientation.
  // Default: `Portrait`
  orientation?: 'Portrait' | 'Landscape';
  // Use this property to set the sheet size.
  // Default: `Letter`
  pageSize?: 'Letter' | 'Letter Small' | 'Tabloid' | 'Ledger' | 'Legal' | 'Statement' | 'Executive' | 'A3' | 'A4' | 'A4 Small' | 'A5' | 'A6' | 'B4' | 'B5' | 'Folio' | 'Envelope' | 'Envelope DL' | 'Envelope C5' | 'Envelope B5' | 'Envelope C3' | 'Envelope C4' | 'Envelope C6' | 'Envelope Monarch' | 'Japanese Postcard' | 'Japanese Double Postcard';
}

headerFooterConfig: ExcelHeaderFooterConfig;

interface ExcelHeaderFooterConfig {
  // The configuration for header and footer on every page. 
  all?: ExcelHeaderFooter;
  // The configuration for header and footer on the first page only. 
  first?: ExcelHeaderFooter;
  // The configuration for header and footer on even numbered pages only. 
  even?: ExcelHeaderFooter;
}

addImageToCell = (
    rowIndex: number,
    column: Column,
    value: string
) => { image: ExcelImage; value?: string; } | undefined;

interface ExcelImage {
  // The image `id`. This field is required so the same image doesn't get imported multiple times.
  id: string;
  // A base64 string that represents the image being imported.
  base64: string;
  // The type of image being exported. 
  imageType: 'jpg' | 'png' | 'gif';
  // Alt Text for the image. 
  altText?: string;
  // If set to `true`, the image will cover the whole cell that is being imported to.
  // Default: `false`
  fitCell?: boolean;
  // Set a value between 0 - 100 that will indicate the percentage of transparency of the image.
  // Default: `0`
  transparency?: number;
  // Set a value between 0 - 359 that will indicate the number of degrees to rotate the image clockwise.
  // Default: `0`
  rotation?: number;
  // Set this property to select a preset that changes the appearance of the image. 
  recolor?: 'Grayscale' | 'Sepia' | 'Washout';
  // The width of the image in pixels. If this value is not selected, `fitCell` will be automatically set to true. 
  width?: number;
  // The height of the image in pixels. If this value is not selected, `fitCell` will be automatically set to true. 
  height?: number;
  // Position of the image. 
  position?: ExcelImagePosition;
}

prependContent: ExcelRow[];

interface ExcelRow {
  // Collapsed state. 
  collapsed?: boolean;
  // Hidden state. 
  hidden?: boolean;
  // The height of the row. 
  height?: number;
  // The indentation level if the current row is part of a row group. 
  outlineLevel?: number;
  // An array of ExcelCells. 
  cells: ExcelCell[];
}

appendContent: ExcelRow[];

interface ExcelRow {
  // Collapsed state. 
  collapsed?: boolean;
  // Hidden state. 
  hidden?: boolean;
  // The height of the row. 
  height?: number;
  // The indentation level if the current row is part of a row group. 
  outlineLevel?: number;
  // An array of ExcelCells. 
  cells: ExcelCell[];
}

getCustomContentBelowRow = (
    params: ProcessRowGroupForExportParams
) => ExcelRow[] | undefined;

interface ProcessRowGroupForExportParams<TData = any, TContext = any> {
  // Row node. 
  node: IRowNode<TData>;
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: TContext;
}

interface ExcelRow {
  // Collapsed state. 
  collapsed?: boolean;
  // Hidden state. 
  hidden?: boolean;
  // The height of the row. 
  height?: number;
  // The indentation level if the current row is part of a row group. 
  outlineLevel?: number;
  // An array of ExcelCells. 
  cells: ExcelCell[];
}

rowPositions: RowPosition[];

interface RowPosition {
  // A positive number from 0 to n, where n is the last row the grid is rendering
  // or -1 if you want to navigate to the grid header 
  rowIndex: number;
  // Either 'top', 'bottom' or null/undefined (for not pinned) 
  rowPinned: RowPinnedType;
}

type RowPinnedType = 
      'top' 
    | 'bottom' 
    | null 
    | undefined

shouldRowBeSkipped = (
    params: ShouldRowBeSkippedParams
) => boolean;

interface ShouldRowBeSkippedParams<TData = any, TContext = any> {
  // Row node. 
  node: IRowNode<TData>;
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: TContext;
}

processCellCallback = (
    params: ProcessCellForExportParams
) => string;

interface ProcessCellForExportParams<TData = any, TContext = any> {
  value: any;
  accumulatedRowIndex?: number;
  node?: IRowNode<TData> | null;
  column: Column;
  type: string;
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: TContext;
}

processHeaderCallback = (
    params: ProcessHeaderForExportParams
) => string;

interface ProcessHeaderForExportParams<TData = any, TContext = any> {
  column: Column;
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: TContext;
}

processGroupHeaderCallback = (
    params: ProcessGroupHeaderForExportParams
) => string;

interface ProcessGroupHeaderForExportParams<TData = any, TContext = any> {
  columnGroup: ColumnGroup;
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: TContext;
}

processRowGroupCallback = (
    params: ProcessRowGroupForExportParams
) => string;

interface ProcessRowGroupForExportParams<TData = any, TContext = any> {
  // Row node. 
  node: IRowNode<TData>;
  // The grid api. 
  api: GridApi<TData>;
  // The column api. 
  columnApi: ColumnApi;
  // Application context as set on `gridOptions.context`. 
  context: TContext;
}

borderBottom: ExcelBorder;

interface ExcelBorder {
  // The color or the border.
  // Default: `black`
  color?: string;
  // The style of the border.
  // Default: `None`
  lineStyle?: 'None' | 'Continuous' | 'Dash' | 'Dot' | 'DashDot' | 'DashDotDot' | 'SlantDashDot' | 'Double';
  // The thickness of the border from 0 (thin) to 3 (thick).
  // Default: `0`
  weight?: 0 | 1 | 2 | 3;
}

borderLeft: ExcelBorder;

interface ExcelBorder {
  // The color or the border.
  // Default: `black`
  color?: string;
  // The style of the border.
  // Default: `None`
  lineStyle?: 'None' | 'Continuous' | 'Dash' | 'Dot' | 'DashDot' | 'DashDotDot' | 'SlantDashDot' | 'Double';
  // The thickness of the border from 0 (thin) to 3 (thick).
  // Default: `0`
  weight?: 0 | 1 | 2 | 3;
}

borderRight: ExcelBorder;

interface ExcelBorder {
  // The color or the border.
  // Default: `black`
  color?: string;
  // The style of the border.
  // Default: `None`
  lineStyle?: 'None' | 'Continuous' | 'Dash' | 'Dot' | 'DashDot' | 'DashDotDot' | 'SlantDashDot' | 'Double';
  // The thickness of the border from 0 (thin) to 3 (thick).
  // Default: `0`
  weight?: 0 | 1 | 2 | 3;
}

borderTop: ExcelBorder;

interface ExcelBorder {
  // The color or the border.
  // Default: `black`
  color?: string;
  // The style of the border.
  // Default: `None`
  lineStyle?: 'None' | 'Continuous' | 'Dash' | 'Dot' | 'DashDot' | 'DashDotDot' | 'SlantDashDot' | 'Double';
  // The thickness of the border from 0 (thin) to 3 (thick).
  // Default: `0`
  weight?: 0 | 1 | 2 | 3;
}

data: ExcelData;

interface ExcelData {
  // The type of data being in the cell. 
  type: ExcelDataType | ExcelOOXMLDataType;
  // The value of the cell. 
  value: string | null;
}

type: ExcelDataType | ExcelOOXMLDataType;

type ExcelDataType = 
      'String' 
    | 'Formula' 
    | 'Number' 
    | 'Boolean' 
    | 'DateTime' 
    | 'Error'


type ExcelOOXMLDataType = 
      'str' 
    | 's' 
    | 'f' 
    | 'inlineStr' 
    | 'n' 
    | 'b' 
    | 'd' 
    | 'e' 
    | 'empty'

header: ExcelHeaderFooterContent[];

interface ExcelHeaderFooterContent {
  // The value of the text to be included in the header. 
  value: string;
  // Configures where the text should be added: `Left`, `Center` or `Right`.
  // Default: `Left`
  position?: 'Left' | 'Center' | 'Right';
  // The font style of the header/footer value. 
  font?: ExcelFont;
}

footer: ExcelHeaderFooterContent[];

interface ExcelHeaderFooterContent {
  // The value of the text to be included in the header. 
  value: string;
  // Configures where the text should be added: `Left`, `Center` or `Right`.
  // Default: `Left`
  position?: 'Left' | 'Center' | 'Right';
  // The font style of the header/footer value. 
  font?: ExcelFont;
}

position: ExcelImagePosition;

interface ExcelImagePosition {
  // The row containing this image. This property is set automatically, don't change it unless you know what you are doing. 
  row?: number;
  // The amount of rows this image will cover.
  // Default: `1`
  //  
  rowSpan?: number;
  // The column containing this image. This property is set automatically, don't change it unless you know what you are doing. 
  column?: number;
  // The amount of columns this image will cover.
  // Default: `1`
  colSpan?: number;
  // The amount in pixels the image should be offset horizontally.
  // Default: `0`
  offsetX?: number;
  // The amount in pixels the image should be offset vertically.
  // Default: `0`
  offsetY?: number;
}

alignment: ExcelAlignment;

interface ExcelAlignment {
  // Use this property to change the cell horizontal alignment.
  // Default: `Automatic`
  horizontal?: 'Automatic' | 'Left' | 'Center' | 'Right' | 'Fill' | 'Justify' | 'CenterAcrossSelection' | 'Distributed' | 'JustifyDistributed';
  // Use this property to change the level of indentation in the cell.
  // Default: 0
  indent?: number;
  // Use this property to change the cell reading order.
  // Default: `LeftToRight`
  readingOrder?: 'RightToLeft' | 'LeftToRight' | 'Context';
  // The number of degrees between 0 and 359 to rotate the text.
  // Default: `0`
  rotate?: number;
  // If set to `true`, the font size of the cell will automatically change to force the text to fit within the cell.
  // Default: `false`
  shrinkToFit?: boolean;
  // Use this property to change the cell vertical alignment.
  // Default: `Automatic`
  vertical?: 'Automatic' | 'Top' | 'Bottom' | 'Center' | 'Justify' | 'Distributed' | 'JustifyDistributed';
  // If set to `true`, multiline text will be displayed as multiline by Excel.
  // Default: `false`
  wrapText?: boolean;
}

borders: ExcelBorders;

interface ExcelBorders {
  // Use to set the cell's bottom border. 
  borderBottom?: ExcelBorder;
  // Use to set the cell's left border. 
  borderLeft?: ExcelBorder;
  // Use to set the cell's right border. 
  borderRight?: ExcelBorder;
  // Use to set the cell's top border. 
  borderTop?: ExcelBorder;
}

dataType: ExcelDataType;

type ExcelDataType = 
      'String' 
    | 'Formula' 
    | 'Number' 
    | 'Boolean' 
    | 'DateTime' 
    | 'Error'

interior: ExcelInterior;

interface ExcelInterior {
  // Use this property to set background color patterns. 
  pattern: 'None' | 'Solid' | 'Gray75' | 'Gray50' | 'Gray25' | 'Gray125' | 'Gray0625' | 'HorzStripe' | 'VertStripe' | 'ReverseDiagStripe' | 'DiagStripe' | 'DiagCross' | 'ThickDiagCross' | 'ThinHorzStripe' | 'ThinVertStripe' | 'ThinReverseDiagStripe' | 'ThinDiagStripe' | 'ThinHorzCross' | 'ThinDiagCross';
  // The colour to be used as a secondary colour combined with patterns. 
  color?: string;
  // The pattern color. 
  patternColor?: string;
}

numberFormat: ExcelNumberFormat;

interface ExcelNumberFormat {
  // Use this property to provide a pattern to format a number. (eg. 10000 could become $10,000.00). 
  format: string;
}

protection: ExcelProtection;

interface ExcelProtection {
  // Set to `false` to disable cell protection (locking)
  // Default: `true`
  protected: boolean;
  // Set to `true` to hide formulas within protected cells.
  // Default: `false`
  hideFormula: boolean;
}