ag-grid/src/ts/interfaces/iExcelCreator.ts

Advanced Data Grid / Data Table supporting Javascript / React / AngularJS / Web Components

import {CsvExportParams, ExportParams} from "../exportParams";

export interface ExcelWorksheet {
    name: string;
    table: ExcelTable;
}

export interface ExcelTable {
    columns: ExcelColumn[];
    rows: ExcelRow[];
}

export interface ExcelColumn {
    width: number;
}

export interface ExcelRow {
    cells: ExcelCell[];
}

export interface ExcelCell {
    styleId: string;
    data: ExcelData;
    mergeAcross?: number;
}

export interface ExcelData {
    type: ExcelDataType;
    value: string;
}

export type ExcelDataType =
    "String"
    | "Number"
    | "Boolean"
    | "DateTime"
    | "Error";

export interface ExcelStyle {
    id?: string;
    name?: string;
    alignment?: ExcelAlignment;
    borders?: ExcelBorders;
    font?: ExcelFont;
    interior?: ExcelInterior;
    numberFormat?: ExcelNumberFormat;
    protection?: ExcelProtection;
    dataType?: string;
}

export interface ExcelProtection {
    protected: boolean;
    hideFormula: boolean;
}

export interface ExcelNumberFormat {
    format: string;
}

export interface ExcelAlignment {
    vertical: string;
    indent: number;
    horizontal: string;
    readingOrder: string;
    rotate: number;
    shrinkToFit: boolean;
    verticalText: boolean;
    wrapText: boolean;
}

export interface ExcelBorders {
    borderBottom: ExcelBorder;
    borderLeft: ExcelBorder;
    borderTop: ExcelBorder;
    borderRight: ExcelBorder;
}

export interface ExcelBorder {
    lineStyle: string;
    weight: number;
    color: string;
}

export interface ExcelFont {
    bold: boolean;
    color: string;
    fontName: string;
    italic: boolean;
    outline: boolean;
    shadow: boolean;
    size: number;
    strikeThrough: boolean;
    underline: string;
    verticalAlign: string;
    charSet: number;
    family: string;
}

export interface ExcelInterior {
    color: string;
    pattern: string;
    patternColor: string;
}

export interface ExcelExportParams extends ExportParams<ExcelCell[][]> {
    sheetName?: string;
    suppressTextAsCDATA?:boolean;
}

export interface IExcelCreator {
    exportDataAsExcel(params?: ExcelExportParams): void ;

    getDataAsExcelXml(params?: ExcelExportParams): string ;
}