/*!
*
* Wijmo Library 5.20251.40
* https://developer.mescius.com/wijmo
*
* Copyright(c) MESCIUS inc. All rights reserved.
*
* Licensed under the End-User License Agreement For MESCIUS Wijmo Software.
* us.sales@mescius.com
* https://developer.mescius.com/wijmo/licensing
*
*/
/**
* {@module wijmo.xlsx}
* This module has a dependency on the JSZip
* library, which must be installed separately.
* * In order to use asynchronous {@link Workbook.saveAsync} and {@link Workbook.loadAsync}
* methods, install JSZip version 3.*:
* ```
* npm install jszip@3 --save
* ```
* * In order to use synchronous {@link Workbook.save} and {@link Workbook.load}
* methods, install JSZip version 2.*:
* ```
* npm install jszip@2 --save
* ```
* If your application is not based on npm, and you load modules using _script_ elements
* in _html_, you can load it from CDN with a markup like this:
* For JSZip 3
* ```html
*
* ```
* For JSZip 2
* ```html
*
* ```
*/
/**
*
*/
export declare var ___keepComment: any;
import * as selfModule from 'wijmo/wijmo.xlsx';
/**
* Represents an Excel workbook.
*/
export declare class Workbook implements IWorkbook {
/**
* Gets or sets the name of application that generated the file that appears in the file properties.
*/
application: string;
/**
* Gets or sets the name of company that generated the file that appears in the file properties.
*/
company: string;
/**
* Gets or sets the creator of the xlsx file.
*/
creator: string;
/**
* Gets or sets the creation time of the xlsx file.
*/
created: Date;
/**
* Gets or sets the last modifier of the xlsx file.
*/
lastModifiedBy: string;
/**
* Gets or sets the last modified time of the xlsx file.
*/
modified: Date;
/**
* Gets or sets the index of the active sheet in the xlsx file.
*/
activeWorksheet: number;
private _reservedContent;
private _sheets;
private _styles;
private _definedNames;
private _tableStyles;
private _colorThemes;
private static _alphabet;
private static _formatMap;
/**
* Initializes a new instance of the {@link Workbook} class.
*/
constructor();
/**
* Gets the WorkSheet array of the workbook.
*/
readonly sheets: WorkSheet[];
/**
* Gets the styles table of the workbook.
*/
readonly styles: WorkbookStyle[];
/**
* Gets the defined name items of the workbook.
*/
readonly definedNames: DefinedName[];
/**
* Gets the color of the workbook themes.
*/
readonly colorThemes: string[];
/**
* Gets or sets the reserved content from xlsx file that flexgrid or flexsheet doesn't support yet.
*/
reservedContent: any;
/**
* Saves the book to a file and returns a base-64 string representation of
* the book.
* This method works with JSZip version 2.* only.
*
* For example, this sample creates an xlsx file with a single cell:
*
* function exportXlsx(fileName) {
* var book = new wijmo.xlsx.Workbook(),
* sheet = new wijmo.xlsx.WorkSheet(),
* bookRow = new wijmo.xlsx.WorkbookRow(),
* bookCell = new wijmo.xlsx.WorkbookCell();
* bookCell.value = 'Hello, Excel!';
* bookRow.cells.push(bookCell);
* sheet.rows.push(bookRow);
* book.sheets.push(sheet);
* book.save(fileName);
* }
*
* The file name is optional. If not provided, the method still returns
* a base-64 string representing the book. This string can be used for
* further processing on the client or on the server.
*
* @param fileName Name of the xlsx file to save.
* @return A base-64 string that represents the content of the file.
*/
save(fileName?: string): string;
private _cs;
/**
* Saves the book to a file asynchronously.
* This method works with JSZip version 3.* only.
*
* @param fileName Name of the xlsx file to save.
* @param onSaved This callback provides an approach to get the base-64 string
* that represents the content of the saved workbook. Since this method is an
* asynchronous method, user does not get the base-64 string immediately.
* User has to get the base-64 string via this callback.
* This has a single parameter, the base-64 string of the saved workbook.
* It will be passed to user.
* @param onError This callback catches error information when saving.
* This has a single parameter, the failure reason.
* Return value will be passed to user, if he wants to catch the save failure reason.
* @param onProgress Callback function that gives feedback about the progress of a task.
* The function accepts a single argument, the current progress as a number between 0 and 100.
*
* For example:
*
* workbook.saveAsync('', function (base64){
* // User can access the base64 string in this callback.
* document.getElementByID('export').href = 'data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;' + 'base64,' + base64;
* }, function (reason){
* // User can catch the failure reason in this callback.
* console.log('The reason of save failure is ' + reason);
* });
*
*/
saveAsync(fileName?: string, onSaved?: (base64?: string) => any, onError?: (reason?: any) => any, onProgress?: (value: number) => void): void;
_externalCancellation: () => _ICancellationSource;
/**
* Cancels the export started by the {@link saveAsync} method.
* @param done Callback invoked when the method finishes executing.
*/
cancelAsync(done?: () => void): void;
/**
* Loads from ArrayBuffer, base-64 string or data url.
* This method works with JSZip version 2.* only.
*
* For example:
* // This sample opens an xlsx file chosen from Open File
* // dialog and creates a workbook instance to load the file.
*
* // HTML
* <input type="file"
* id="importFile"
* accept="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
* />
*
* // JavaScript
* var workbook, // receives imported IWorkbook
* importFile = document.getElementById('importFile');
*
* importFile.addEventListener('change', function () {
* loadWorkbook();
* });
*
* function loadWorkbook() {
* var reader,
* workbook,
* file = importFile.files[0];
* if (file) {
* reader = new FileReader();
* reader.onload = function (e) {
* workbook = new wijmo.xlsx.Workbook(),
* workbook.load(reader.result);
* };
* reader.readAsDataURL(file);
* }
* }
*
* @param data ArrayBuffer or base-64 string that contains the xlsx file content.
* @param includeStyles Indicates whether styles should be imported from xlsx file. The default value is **true**.
*/
load(data: string | ArrayBuffer, includeStyles?: boolean): void;
/**
* Loads from ArrayBuffer or base-64 string or data url asynchronously.
* This method works with JSZip version 3.* only.
*
* @param data ArrayBuffer or base-64 string that contains the xlsx file content.
* @param onLoaded This callback provides an approach to get an instance of the loaded workbook.
* Since this method is an asynchronous method, user is not able to get instance of
* the loaded workbook immediately. User has to get the instance through this callback.
* This has a single parameter, instance of the loaded workbook. It will be passed to user.
* @param onError This callback catches error information when loading.
* This has a single parameter, the failure reason. Return value is
* be passed to user, if he wants to catch the load failure reason.
*
* For example:
*
* workbook.loadAsync(base64, function (workbook) {
* // User can access the loaded workbook instance in this callback.
* var app = worksheet.application ;
* ...
* }, function (reason) {
* // User can catch the failure reason in this callback.
* console.log('The reason of load failure is ' + reason);
* });
*
* @param includeStyles Indicates whether styles should be imported from xlsx file. The default value is **true**.
*/
loadAsync(data: string | ArrayBuffer, onLoaded: (workbook: Workbook) => void, onError?: (reason?: any) => any, includeStyles?: boolean): void;
_serialize(): IWorkbook;
_deserialize(workbookOM: IWorkbook): void;
_addWorkSheet(workSheet: WorkSheet, sheetIndex?: number): void;
static _saveToFile(base64: string, fileName: string, containMarcos: boolean): void;
private _getBase64String;
/**
* Converts the wijmo date format to Excel format.
*
* @param format The wijmo date format.
* @return Excel format representation.
*/
static toXlsxDateFormat(format: string): string;
/**
* Converts the wijmo number format to xlsx format.
*
* @param format The wijmo number format.
* @return Excel format representation.
*/
static toXlsxNumberFormat(format: string): string;
/**
* Converts the xlsx multi-section format string to an array of corresponding wijmo formats.
*
* @param xlsxFormat The Excel format string, that may contain multiple format sections
* separated by a semicolon.
* @return An array of .Net format strings where each element corresponds to a separate
* Excel format section.
* The returning array always contains at least one element. It can be an empty string
* in case the passed Excel format is empty.
*/
static fromXlsxFormat(xlsxFormat: string): string[];
static _fromXlsxDateFormat(format: string): string;
static _parseCellFormat(format: string, isDate: boolean): string;
static _parseExcelFormat(item: IWorkbookCell): string;
/**
* Converts zero-based cell, row or column index to Excel alphanumeric representation.
*
* @param row The zero-based row index or a null value if only column index
* is to be converted.
* @param col The zero-based column index or a null value if only row index
* is to be converted.
* @param absolute True value indicates that absolute indices is to be returned
* for both, row and column (like $D$7). The absoluteCol parameter allows
* to redefine this value for the column index.
* @param absoluteCol True value indicates that column index is absolute.
* @param isWholeRow Indicates whether the Cell reference is whole row, whole column or specific cell range.
* If isWholeRow is true means the cell reference is whole row.
* If isWholeRow is false means the cell reference is whole column.
* If isWholeRow is null means the cell reference is specific cell range.
* @return The alphanumeric Excel index representation.
*/
static xlsxAddress(row: number, col: number, absolute?: boolean, absoluteCol?: boolean, isWholeRow?: boolean): string;
/**
* Convert Excel's alphanumeric cell, row or column index to the zero-based
* row/column indices pair.
*
* @param xlsxIndex The alphanumeric Excel index that may include alphabetic A-based
* column index and/or numeric 1-based row index, like "D15", "D" or "15". The
* alphabetic column index can be in lower or upper case.
* @return The object with row and col properties containing zero-based
* row and/or column indices.
* If row or column component is not specified in the alphanumeric index, then
* corresponding returning property is undefined.
*/
static tableAddress(xlsxIndex: string): ITableAddress;
static _parseHAlignToString(hAlign: HAlign): string;
static _parseStringToHAlign(hAlign: string): HAlign;
static _parseVAlignToString(vAlign: VAlign): string;
static _parseStringToVAlign(vAlign: string): VAlign;
static _parseBorderTypeToString(type: BorderStyle): string;
static _parseStringToBorderType(type: string): BorderStyle;
static _escapeXML(s: any): string;
static _unescapeXML(val: any): string;
private static _numAlpha;
private static _alphaNum;
private _serializeWorkSheets;
private _serializeWorkbookStyles;
private _serializeDefinedNames;
private _serializeTableStyles;
private _deserializeWorkSheets;
private _deserializeWorkbookStyles;
private _deserializeDefinedNames;
private _deserializeTableStyles;
}
/**
* Represents the Workbook Object Model sheet definition that includes sheet
* properties and data.
*
* The sheet cells are stored in row objects and are accessible using JavaScript
* expressions like sheet.rows[i].cells[j].
*/
export declare class WorkSheet implements IWorkSheet {
/**
* Gets or sets the sheet name.
*/
name: string;
/**
* Gets or sets the {@link WorkbookFrozenPane} settings.
*/
frozenPane: WorkbookFrozenPane;
/**
* Gets or sets a value indicating whether summary rows appear below or
* above detail rows.
*/
summaryBelow: boolean;
/**
* Gets or sets the worksheet visibility.
*/
visible: boolean;
/**
* Gets or sets the row style.
*
* The property defines the style for all cells in the worksheet, and
* can be overridden by the specific cell styles.
*/
style: WorkbookStyle;
/**
* Indicates whether the sheet is in "right to left" display mode, i.e. when Column A is placed on the far right.
* The default value is **undefined**, which means **false**.
*/
rightToLeft: boolean;
private _columns;
private _rows;
private _tables;
_extraColumn: _WorkbookExtraColumn;
/**
* Initializes a new instance of the {@link WorkSheet} class.
*/
constructor();
/**
* Gets or sets an array of sheet columns definitions.
*
* Each {@link WorkbookColumn} object in the array describes a column
* at the corresponding position in xlsx sheet, i.e. the column with index 0
* corresponds to xlsx sheet column with index A, object with
* index 1 defines sheet column with index B, and so on. If certain column
* has no description in xlsx file, then corresponding array element
* is undefined for both export and import operations.
*
* If {@link WorkbookColumn} object in the array doesn't specify the
* width property value, then the default column width is applied.
*/
readonly columns: WorkbookColumn[];
/**
* Gets an array of sheet rows definition.
*
* Each {@link WorkbookRow} object in the array describes a row at the corresponding
* position in xlsx sheet, i.e. the row with index 0 corresponds to excel sheet
* row with index 1, object with index 1 defines sheet row with index 2, and so on.
* If certain row has no properties and data in xlsx file, then corresponding array
* element is undefined for both export and import operations.
*
* If {@link WorkbookRow} object in the array doesn't specify the height property
* value, then the default row height is applied.
*/
readonly rows: WorkbookRow[];
/**
* Gets the name of tables refered in this worksheet.
*/
readonly tables: WorkbookTable[];
_serialize(): IWorkSheet;
_deserialize(workSheetOM: _IWorkSheet): void;
_addWorkbookColumn(column: WorkbookColumn, columnIndex?: number): void;
_addWorkbookRow(row: WorkbookRow, rowIndex?: number): void;
private _serializeWorkbookColumns;
private _serializeWorkbookRows;
private _serializeTables;
private _deserializeWorkbookColumns;
private _deserializeWorkbookRows;
private _deserializeTables;
private _checkEmptyWorkSheet;
}
/**
* Represents the Workbook Object Model column definition.
*/
export declare class WorkbookColumn implements IWorkbookColumn {
/**
* Gets or sets the width of the column in device-independent
* (1/96th inch) pixels or characters.
*
* The numeric value defines the width in pixels. On import,
* the widths are always expressed in pixels.
*
* The string value which is a number with the 'ch' suffix,
* for example '10ch', defines the width in characters.
* It has the same meaning as the column width defined through
* Excel UI. The width can be specified in characters
* for the export operations only.
*
* If width is not specified, then the default width is applied.
*/
width: any;
/**
* Gets or sets the column visibility.
*/
visible: boolean;
/**
* Gets or sets the column style.
*
* The property defines the style for all cells in the column,
* and can be overridden by the specific cell styles.
*/
style: WorkbookStyle;
/**
* Gets or sets a value that determines whether the column width
* will be automatically increased to fit numeric/date contents
* after the user edits a cell.
*/
autoWidth: boolean;
/**
* Initializes a new instance of the {@link WorkbookColumn} class.
*/
constructor();
_serialize(): IWorkbookColumn;
_deserialize(workbookColumnOM: IWorkbookColumn): void;
private _checkEmptyWorkbookColumn;
}
export declare class _WorkbookExtraColumn extends WorkbookColumn implements _IWorkbookExtraColumn {
min: number;
max: number;
constructor();
_serialize(): _IWorkbookExtraColumn;
_deserialize(workbookColumnOM: _IWorkbookExtraColumn): void;
}
/**
* Represents the Workbook Object Model row definition.
*/
export declare class WorkbookRow implements IWorkbookRow {
/**
* Gets or sets the row height in device-independent (1/96th inch) pixels.
*
* If height is not specified, then the default height is applied.
*/
height: number;
/**
* Gets or sets the row visibility.
*/
visible: boolean;
/**
* Gets or sets the group level of the row.
*/
groupLevel: number;
/**
* Gets or sets the row style.
*
* The property defines the style for all cells in the row,
* and can be overridden by the specific cell styles.
*/
style: WorkbookStyle;
/**
* Indicating if the row is in the collapsed outline state.
*/
collapsed: boolean;
private _cells;
/**
* Initializes a new instance of the {@link WorkbookRow} class.
*/
constructor();
/**
* Gets or sets an array of cells in the row.
*
* Each {@link WorkbookCell} object in the array describes a cell
* at the corresponding position in the row, i.e. a cell with
* index 0 pertains to column with index A, a cell with index 1
* defines cell pertaining to column with index B, and so on.
* If a certain cell has no definition (empty) in xlsx file,
* then corresponding array element is undefined for both export
* and import operations.
*/
readonly cells: WorkbookCell[];
_serialize(): IWorkbookRow;
_deserialize(workbookRowOM: IWorkbookRow): void;
_addWorkbookCell(cell: WorkbookCell, cellIndex?: number): void;
private _serializeWorkbookCells;
private _deserializeWorkbookCells;
private _checkEmptyWorkbookRow;
}
/**
* Represents the Workbook Object Model cell definition.
*/
export declare class WorkbookCell implements IWorkbookCell {
/**
* Gets or sets the cell value.
*
* The type of the value can be String, Number, Boolean or Date.
*/
value: any;
/**
* Indicates whether the cell value is date or not.
*/
isDate: boolean;
/**
* Indicates whether the cell value is number or not.
*/
isNumber: boolean;
/**
* Gets or sets the formula of cell.
*/
formula: string;
/**
* Gets or sets the style of cell.
*/
style: WorkbookStyle;
/**
* Gets or sets the colSpan setting of cell.
*/
colSpan: number;
/**
* Gets or sets the rowSpan setting of cell.
*/
rowSpan: number;
/**
* Gets or sets the hyperlink of cell.
*/
link: string;
/**
* Gets or sets the text runs represent the rich text of cell.
*/
textRuns: WorkbookTextRun[];
/**
* Gets or sets the note of the cell.
*/
note: WorkbookNote;
/**
* Initializes a new instance of the {@link WorkbookCell} class.
*/
constructor();
_serialize(): IWorkbookCell;
_deserialize(workbookCellOM: IWorkbookCell): void;
private _checkEmptyWorkbookCell;
}
/**
* Represents the Workbook Object Model note definition.
*/
export declare class WorkbookNote implements IWorkbookNote {
/**
* Gets or sets the author of the note.
* The default value is **undefined**.
*/
author: string;
/**
* Gets or sets the text of the note.
* The default value is **undefined**.
*
* Note that on import both this and {@link textRuns} properties are filled and this property contains a plain text version of the {@link textRuns} content.
* On export {@link textRuns} takes precedence over this property if both are set.
*/
text: string;
/**
* Gets or sets the text runs represent the rich text of the note.
* The default value is **undefined**.
*
* Note that on import both this and {@link text} properties are filled and {@link text} contains a plain text version of the content of this property.
* On export this property takes precedence over {@link text} if both are set.
*/
textRuns: WorkbookTextRun[];
/**
* Indicates whether the note will be displayed when you open an .xlsx file or whether it will be displayed when your hover over the owner's cell.
* The default value is **undefined**, which means **true**.
*/
visible: boolean;
/**
* Gets or sets the offset in the X coordinate relative to bottom-right corner of the cell, in pixels.
* The default value is **undefined**, which causes to use the default offset, 15 pixels.
*/
offsetX: number;
/**
* Gets or sets the offset in the Y coordinate relative to bottom-right corner of the cell, in pixels.
* The default value is **undefined**, which causes to use the default offset, 2 pixels if the cell is in the first row, 15 pixels otherwise.
*/
offsetY: number;
/**
* Gets or sets the width of the note, in pixels.
* The default value is **undefined**, which causes to use the default width, 144 pixels.
*/
width: number;
/**
* Gets or sets the height of the note, in pixels.
* The default value is **undefined**, which causes to use the default height, 79 pixels.
*/
height: number;
/**
* Initializes a new instance of the {@link WorkbookNote} class.
*/
constructor();
_serialize(): IWorkbookNote;
_deserialize(om: IWorkbookNote): void;
}
/**
* Workbook frozen pane definition
*/
export declare class WorkbookFrozenPane implements IWorkbookFrozenPane {
/**
* Gets or sets the number of frozen rows.
*/
rows: number;
/**
* Gets or sets the number of frozen columns.
*/
columns: number;
/**
* Initializes a new instance of the {@link WorkbookFrozenPane} class.
*/
constructor();
_serialize(): IWorkbookFrozenPane;
_deserialize(workbookFrozenPaneOM: IWorkbookFrozenPane): void;
}
/**
* Represents the Workbook Object Model style definition used
* to style Excel cells, columns and rows.
*/
export declare class WorkbookStyle implements IWorkbookStyle {
/**
* Cell value format, defined using Excel format syntax.
*
* The description of Excel format syntax can be found
* here.
*
* You may use the toXlsxNumberFormat and toXlsxDateFormat static
* functions of the {@link Workbook} class to convert from .Net ({@link Globalize})
* format to Excel format.
*/
format: string;
/**
* Defines the base style that this style inherits.
*
* This property is applicable for the export operations only.
* The style gets all the properties defined in the base style,
* and can override or augment them by setting its own properties.
*/
basedOn: WorkbookStyle;
/**
* Gets or sets the font of style.
*/
font: WorkbookFont;
/**
* Gets or sets the horizontal alignment of text.
*/
hAlign: HAlign;
/**
* Gets or sets the vertical alignment of text.
*/
vAlign: VAlign;
/**
* Gets or sets the indent setting of style.
*/
indent: number;
/**
* Gets or sets the background setting.
*/
fill: WorkbookFill;
/**
* Gets or sets the border setting.
*/
borders: WorkbookBorder;
/**
* Gets or sets the word wrap setting of row.
*/
wordWrap: boolean;
/**
* Gets or sets the number format Id.
*/
numFormatId: number;
/**
* Initializes a new instance of the {@link WorkbookStyle} class.
*/
constructor();
_serialize(): IWorkbookStyle;
_deserialize(workbookStyleOM: IWorkbookStyle): void;
private _checkEmptyWorkbookStyle;
}
/**
* Represents the Workbook Object Model font definition.
*/
export declare class WorkbookFont implements IWorkbookFont {
/**
* Gets or sets the font family name.
*/
family: string;
/**
* Gets or sets the font size in device-independent (1/96th inch) pixels.
*/
size: number;
/**
* Indicates whether the current font is bold.
*/
bold: boolean;
/**
* Indicates whether the current font has the italic style applied.
*/
italic: boolean;
/**
* Indicates whether the current font is underlined.
*/
underline: boolean;
/**
* Gets or sets the font color.
*
* For export, the color can be specified in any valid HTML format
* like 6-character dash notation or rgb/rgba/hsl/hsla functional form.
* In case of rgba/hsla representations, specified alpha channel value
* is ignored.
*
* For import, a value is always represented in the HTML 6-character dash
* notation, for example, "#afbfcf".
*/
color: string;
/**
* Initializes a new instance of the {@link WorkbookFont} class.
*/
constructor();
_serialize(): IWorkbookFont;
_deserialize(workbookFontOM: IWorkbookFont): void;
private _checkEmptyWorkbookFont;
}
/**
* Represents the Workbook Object Model background fill definition.
*/
export declare class WorkbookFill implements IWorkbookFill {
/**
* Gets or sets the fill color.
*
* For export, the color can be specified in any valid HTML format
* like 6-character dash notation or rgb/rgba/hsl/hsla functional form.
* In case of rgba/hsla representations, specified alpha channel value
* is ignored.
*
* For import, a value is always represented in the HTML 6-character dash
* notation, for example, "#afbfcf".
*/
color: string;
/**
* Initializes a new instance of the {@link WorkbookFill} class.
*/
constructor();
_serialize(): IWorkbookFill;
_deserialize(workbookFillOM: IWorkbookFill): void;
}
/**
* Represents the Workbook Object Model border definition.
*/
export declare class WorkbookBorder implements IWorkbookBorder {
/**
* Gets or sets the top border setting.
*/
top: WorkbookBorderSetting;
/**
* Gets or sets the bottom border setting.
*/
bottom: WorkbookBorderSetting;
/**
* Gets or sets the left border setting.
*/
left: WorkbookBorderSetting;
/**
* Gets or sets the right border setting.
*/
right: WorkbookBorderSetting;
/**
* Gets or sets the diagonal border setting.
*/
diagonal: WorkbookBorderSetting;
/**
* Initializes a new instance of the {@link WorkbookBorder} class.
*/
constructor();
_serialize(): IWorkbookBorder;
_deserialize(workbookBorderOM: IWorkbookBorder): void;
private _checkEmptyWorkbookBorder;
}
/**
* Represents the Workbook Object Model background setting definition.
*/
export declare class WorkbookBorderSetting implements IWorkbookBorderSetting {
/**
* Gets or sets the border color.
*
* For export, the color can be specified in any valid HTML format
* like 6-character dash notation or rgb/rgba/hsl/hsla functional form.
* In case of rgba/hsla representations, specified alpha channel value
* is ignored.
*
* For import, a value is always represented in the HTML 6-character dash
* notation, for example, "#afbfcf".
*/
color: string;
/**
* Gets or sets the border type.
*/
style: BorderStyle;
/**
* Initializes a new instance of the {@link WorkbookBorderSetting} class.
*/
constructor();
_serialize(): IWorkbookBorderSetting;
_deserialize(workbookBorderSettingOM: IWorkbookBorderSetting): void;
}
/**
* Represents the Workbook Object Model Defined Name item definition.
*/
export declare class DefinedName implements IDefinedName {
/**
* The name of the defined name item.
*/
name: string;
/**
* The value of the defined name item.
* The value could be a formula, a string constant or a cell range.
* For e.g. "Sum(1, 2, 3)", "test" or "sheet1!A1:B2"
*/
value: any;
/**
* Indicates the defined name item works in which sheet.
* If omitted, the defined name item works in workbook
*/
sheetName: string;
/**
* Initializes a new instance of the {@link DefinedName} class.
*/
constructor();
_serialize(): IDefinedName;
_deserialize(definedNameOM: IDefinedName): void;
}
/**
* Represents the WorkbookTable Object Model background setting definition.
*/
export declare class WorkbookTable implements IWorkbookTable {
/**
* The name of the table. It is used to reference the table programmatically.
*/
name: string;
/**
* The range on the relevant sheet that the table occupies expressed using A1 style referencing. i.e. "A1:D4".
* The reference shall include the totals row if it is shown.
*/
range: string;
/**
* Indicates whether show the header row for the table.
*/
showHeaderRow: boolean;
/**
* Indicates whether show the total row for the table.
*/
showTotalRow: boolean;
/**
* Indicating whether banded column formatting is applied.
*/
showBandedColumns: boolean;
/**
* The table style to use with the table.
*/
style: WorkbookTableStyle;
/**
* Indicating whether banded row formatting is applied.
*/
showBandedRows: boolean;
/**
* Indicating whether the first column in the table should have the style applied.
*/
alterFirstColumn: boolean;
/**
* Indicating whether the last column in the table should have the style applied.
*/
alterLastColumn: boolean;
private _columns;
/**
* The columns of the table.
*/
readonly columns: WorkbookTableColumn[];
/**
* Initializes a new instance of the {@link WorkbookTable} class.
*/
constructor();
_serialize(): IWorkbookTable;
_deserialize(workbookTableOM: IWorkbookTable): void;
private _serializeTableColumns;
private _deserializeTableColumns;
}
/**
* Represents the WorkbookTableColumn Object Model background setting definition.
*/
export declare class WorkbookTableColumn implements IWorkbookTableColumn {
/**
* The name of the table column. It is referenced through functions.
*/
name: string;
/**
* The string to show in the totals row cell for the column.
*/
totalRowLabel: string;
/**
* The function to show in the totals row cell for this column.
*/
totalRowFunction: string;
/**
* Indicating whether show filter button for the column.
*/
showFilterButton: boolean;
/**
* Initializes a new instance of the {@link WorkbookTableColumn} class.
*/
constructor();
_serialize(): IWorkbookTableColumn;
_deserialize(workbookTableColumnOM: IWorkbookTableColumn): void;
}
/**
* Represents the WorkbookTableStyle Object Model background setting definition.
*/
export declare class WorkbookTableStyle implements IWorkbookTableStyle {
/**
* The name of the table style.
*/
name: string;
/**
* The whole table style.
*/
wholeTableStyle: WorkbookTableCommonStyle;
/**
* The first column stripe style.
*/
firstBandedColumnStyle: WorkbookTableBandedStyle;
/**
* The second column stripe style.
*/
secondBandedColumnStyle: WorkbookTableBandedStyle;
/**
* The first row stripe style.
*/
firstBandedRowStyle: WorkbookTableBandedStyle;
/**
* The second row stripe style.
*/
secondBandedRowStyle: WorkbookTableBandedStyle;
/**
* The first column style.
*/
firstColumnStyle: WorkbookTableCommonStyle;
/**
* The last column style.
*/
lastColumnStyle: WorkbookTableCommonStyle;
/**
* The header row style.
*/
headerRowStyle: WorkbookTableCommonStyle;
/**
* The total row style.
*/
totalRowStyle: WorkbookTableCommonStyle;
/**
* The first cell style in the header row.
*/
firstHeaderCellStyle: WorkbookTableCommonStyle;
/**
* The last cell style in the header row.
*/
lastHeaderCellStyle: WorkbookTableCommonStyle;
/**
* The first cell style in the total row.
*/
firstTotalCellStyle: WorkbookTableCommonStyle;
/**
* The last cell style in the total row.
*/
lastTotalCellStyle: WorkbookTableCommonStyle;
/**
* Initializes a new instance of the {@link WorkbookTableStyle} class.
*/
constructor();
_serialize(): IWorkbookTableStyle;
_deserialize(workbookTableStyleOM: IWorkbookTableStyle): void;
private _checkEmptyWorkbookTableStyle;
}
/**
* Represents the WorkbookTableCommonStyle Object Model background setting definition.
*/
export declare class WorkbookTableCommonStyle extends WorkbookStyle implements IWorkbookTableCommonStyle {
/**
* Table borders setting.
*/
borders: WorkbookTableBorder;
/**
* Initializes a new instance of the {@link WorkbookTableCommonStyle} class.
*/
constructor();
_deserialize(workbookTableCommonStyleOM: IWorkbookTableCommonStyle): void;
}
/**
* Represents the WorkbookTableBandedStyle Object Model background setting definition.
*/
export declare class WorkbookTableBandedStyle extends WorkbookTableCommonStyle implements IWorkbookTableBandedStyle {
/**
* Number of rows or columns in a single band of striping.
*/
size: number;
/**
* Initializes a new instance of the {@link WorkbookTableBandedStyle} class.
*/
constructor();
_serialize(): IWorkbookTableBandedStyle;
_deserialize(workbookTableBandedStyleOM: IWorkbookTableBandedStyle): void;
}
/**
* Represents the Workbook Object Model table border definition.
*/
export declare class WorkbookTableBorder extends WorkbookBorder implements IWorkbookTableBorder {
/**
* Vertical border setting.
*/
vertical: WorkbookBorderSetting;
/**
* Horizontal border setting.
*/
horizontal: WorkbookBorderSetting;
/**
* Initializes a new instance of the {@link WorkbookTableBorder} class.
*/
constructor();
_serialize(): IWorkbookTableBorder;
_deserialize(workbookBorderOM: IWorkbookTableBorder): void;
}
/**
* Represents the Workbook Object Model text run definition.
*/
export declare class WorkbookTextRun implements IWorkbookTextRun {
/**
* Gets or sets the font of the text run.
*/
font: WorkbookFont;
/**
* Gets or sets the text of the text run.
*/
text: string;
/**
* Initializes a new instance of the {@link WorkbookTextRun} class.
*/
constructor();
_serialize(): IWorkbookTextRun;
_deserialize(workbookTextRunOM: IWorkbookTextRun): void;
}
export interface IXlsxFileContent {
base64: string;
base64Array: Uint8Array;
href: Function;
}
/**
* Represents the Workbook Object Model sheet definition that
* includes sheet properties and data.
*
* The sheet cells are stored in row objects and are accessible
* using JavaScript expressions like sheet.rows[i].cells[j].
*/
export interface IWorkSheet {
/**
* Gets or sets the sheet name.
*/
name?: string;
/**
* Gets or sets an array of sheet columns definitions.
*
* Each {@link IWorkbookColumn} object in the array describes a column at the
* corresponding position in xlsx sheet, i.e. column with index 0 corresponds
* to xlsx sheet column with index A, object with index 1 defines sheet column
* with index B, and so on. If certain column has no description in xlsx file,
* then corresponding array element is undefined for both export and import operations.
*
* If {@link IWorkbookColumn} object in the array doesn't specify the width
* property value, then the default column width is applied.
*/
columns?: IWorkbookColumn[];
/**
* Gets or sets an array of sheet rows definition.
*
* Each {@link IWorkbookRow} object in the array describes a row at the
* corresponding position in xlsx sheet, i.e. row with index 0 corresponds
* to xlsx sheet row with index A, object with index 1 defines sheet row
* with index B, and so on. If certain row has no description in xlsx file,
* then corresponding array element is undefined for both export and import operations.
*
* If {@link IWorkbookRow} object in the array doesn't specify the height
* property value, then the default row height is applied.
*/
rows?: IWorkbookRow[];
/**
* Gets or sets the frozen pane settings.
*/
frozenPane?: IWorkbookFrozenPane;
/**
* Gets or sets a value indicating whether summary rows appear below or above detail rows.
*/
summaryBelow?: boolean;
/**
* Gets or sets the worksheet visibility.
*/
visible?: boolean;
/**
* Gets or sets the sheet style.
*
* The property defines the style for all cells in the worksheet,
* and can be overridden by the specific cell styles.
*/
style?: IWorkbookStyle;
/**
* Gets the tables in this worksheet.
*/
tables?: IWorkbookTable[];
/**
* Indicates whether the sheet is in "right to left" display mode, i.e. when Column A is placed on the far right.
*/
rightToLeft?: boolean;
}
export interface _IWorkSheet extends IWorkSheet {
maxCol?: number;
maxRow?: number;
tableRIds?: string[];
externalLinks?: string[];
_extraColumn?: _IWorkbookExtraColumn;
}
/**
* Represents the Workbook Object Model column definition.
*/
export interface IWorkbookColumn {
/**
* Gets or sets the width of the column in device-independent (1/96th inch) pixels
* or characters.
*
* The numeric value defines the width in pixels. On import, the widths are
* always expressed in pixels.
*
* The string value which is a number with the 'ch' suffix, for example '10ch',
* defines the width in characters. It has the same meaning as the column width
* defined through Excel UI. The width can be specified in characters
* for the export operations only.
*
* If width is not specified, then the default width is applied.
*/
width?: any;
/**
* Gets or sets the column visibility.
*/
visible?: boolean;
/**
* Gets or sets the column style.
*
* The property defines the style for all cells in the column,
* and can be overridden by the specific cell styles.
*/
style?: IWorkbookStyle;
/**
* Gets or sets a value indicating whether the column width is
* automatically adjusted to fit the content of its cells.
*/
autoWidth?: boolean;
}
export interface _IWorkbookExtraColumn extends IWorkbookColumn {
min?: number;
max?: number;
}
/**
* Represents the Workbook Object Model row definition.
*/
export interface IWorkbookRow {
/**
* Gets or sets the row height in device-independent (1/96th inch) pixels.
*
* If height is not specified, then the default height is applied.
*/
height?: number;
/**
* Gets or sets the row visibility.
*/
visible?: boolean;
/**
* Gets or sets the group level of the row.
*/
groupLevel?: number;
/**
* Gets or sets the row style.
*
* The property defines the style for all cells in the row,
* and can be overridden by the specific cell styles.
*/
style?: IWorkbookStyle;
/**
* TBD: Indicating if the row is in the collapsed outline state.
*/
collapsed?: boolean;
/**
* Gets or sets an array of cells in the row.
*
* Each {@link IWorkbookCell} object in the array describes a cell at
* the corresponding position in the row, i.e. cell with index 0
* pertains to column with index A, cell with index 1 defines
* cell pertaining to column with index B, and so on. If a certain cell
* has no definition (empty) in xlsx file, then corresponding array
* element is undefined for both export and import operations.
*/
cells?: IWorkbookCell[];
}
/**
* Represents the Workbook Object Model cell definition.
*/
export interface IWorkbookCell {
/**
* Gets or sets the cell value.
*
* The type of the value can be String, Number, Boolean or Date.
*/
value?: any;
/**
* Indicates whether the cell value is date or not.
*/
isDate?: boolean;
/**
* Indicates whether the cell value is number or not.
*/
isNumber?: boolean;
/**
* Cell formula
*/
formula?: string;
/**
* Cell style
*/
style?: IWorkbookStyle;
/**
* Cell colSpan setting
*/
colSpan?: number;
/**
* Cell rowSpan setting
*/
rowSpan?: number;
/**
* The hyperlink of the cell.
*/
link?: string;
/**
* The text runs represent the rich text of cell.
*/
textRuns?: IWorkbookTextRun[];
/**
* Represents the note of the cell.
*/
note?: IWorkbookNote;
}
/**
* Represents the Workbook Object Model note definition.
*/
export interface IWorkbookNote {
/**
* Gets or sets the author of the note.
* The default value is **undefined**.
*/
author?: string;
/**
* Gets or sets the text of the note.
* The default value is **undefined**.
*
* Note that on import both this and {@link textRuns} properties are filled and this property contains a plain text version of the {@link textRuns} content.
* On export {@link textRuns} takes precedence over this property if both are set.
*/
text?: string;
/**
* Gets or sets the text runs represent the rich text of the note.
* The default value is **undefined**.
*
* Note that on import both this and {@link text} properties are filled and {@link text} contains a plain text version of the content of this property.
* On export this property takes precedence over {@link text} if both are set.
*/
textRuns?: IWorkbookTextRun[];
/**
* Indicates whether the note will be displayed when you open an .xlsx file or whether it will be displayed when your hover over the owner's cell.
* The default value is **undefined**, which means **true**.
*/
visible?: boolean;
/**
* Gets or sets the offset in the X coordinate relative to bottom-right corner of the cell, in pixels.
* The default value is **undefined**, which causes to use the default offset, 15 pixels.
*/
offsetX?: number;
/**
* Gets or sets the offset in the Y coordinate relative to bottom-right corner of the cell, in pixels.
* The default value is **undefined**, which causes to use the default offset, 2 pixels if the cell is in the first row, 15 pixels otherwise.
*/
offsetY?: number;
/**
* Gets or sets the width of the note, in pixels.
* The default value is **undefined**, which causes to use the default width, 144 pixels.
*/
width?: number;
/**
* Gets or sets the height of the note, in pixels.
* The default value is **undefined**, which causes to use the default height, 79 pixels.
*/
height?: number;
_col?: number;
_row?: number;
}
/**
* Workbook frozen pane definition
*/
export interface IWorkbookFrozenPane {
/**
* Gets or sets the number of frozen rows.
*/
rows: number;
/**
* Gets or sets the number of frozen columns.
*/
columns: number;
}
/**
* Represents an Excel Workbook. This interface is the root of the Excel
* Workbook Object Model (WOM) which provides a way to define properties
* and data stored in xlsx file.
*
* To create an xlsx file, create a {@link Workbook} object and populate them
* with {@link WorkSheet}, {@link WorkbookColumn}, {@link WorkbookRow}, and {@link WorkbookCell}
* objects.
*
* To save xlsx files, use the {@link Workbook.save} method which can save the
* book to a file or return it as a base-64 string.
*
* To load existing xlsx files, use the {@link Workbook.load} method which will
* populate the book.
*/
export interface IWorkbook {
/**
* Defines an array of Excel Workbook sheets.
*/
sheets: IWorkSheet[];
/**
* Name of the application that generated the file that appears in the file properties.
*/
application?: string;
/**
* Name of the company that generated the file that appears in the file properties.
*/
company?: string;
/**
* Creator of the xlsx file.
*/
creator?: string;
/**
* Creation time of the xlsx file.
*/
created?: Date;
/**
* Last modifier of the xlsx file.
*/
lastModifiedBy?: string;
/**
* Last modified time of the xlsx file.
*/
modified?: Date;
/**
* Index of the active sheet in the xlsx file.
*/
activeWorksheet?: number;
/**
* Styles table of the workbook.
*/
styles?: IWorkbookStyle[];
/**
* The reserved content for the workbook.
*/
reservedContent?: any;
/**
* The array of the defined name items.
*/
definedNames?: IDefinedName[];
/**
* The color of the workbook themes.
*/
colorThemes?: string[];
}
/**
* Represents the Workbook Object Model style definition used to
* style Excel cells, columns and rows.
*/
export interface IWorkbookStyle {
/**
* Cell value format, defined using Excel format syntax.
*
* The description of Excel format syntax can be found
* here.
*
* You may use the toXlsxNumberFormat and toXlsxDateFormat
* static functions of the {@link Workbook} class to convert from .Net
* ({@link Globalize}) format to Excel format.
*/
format?: string;
/**
* Defines the base style that this style inherits.
*
* This property is applicable for export operations only.
* The style gets all the properties defined in the base style,
* and can override or augment them by setting its own properties.
*/
basedOn?: IWorkbookStyle;
/**
* Gets or sets the font properties.
*/
font?: IWorkbookFont;
/**
* Gets or sets the horizontal alignment of a text.
*/
hAlign?: HAlign;
/**
* Gets or sets the vertical alignment of a text.
*/
vAlign?: VAlign;
/**
* Text indent.
* It is an integer value, where an increment of 1 represents 3 spaces.
*/
indent?: number;
/**
* Cell outline setting.
*/
borders?: IWorkbookBorder;
/**
* Cells background.
*/
fill?: IWorkbookFill;
/**
* Word wrap setting.
*/
wordWrap?: boolean;
/**
* Underlying number format Id
*/
numFormatId?: number;
}
/**
* Represents the Workbook Object Model font definition.
*/
export interface IWorkbookFont {
/**
* Gets or sets the font family name.
*/
family?: string;
/**
* Gets or sets the font size in device-independent (1/96th inch) pixels.
*/
size?: number;
/**
* Gets or sets a value indicating whether this font is bold.
*/
bold?: boolean;
/**
* Gets or sets a value indicating whether this font has the italic style applied.
*/
italic?: boolean;
/**
* Gets or sets a value indicating whether this font is underlined.
*/
underline?: boolean;
/**
* Gets or sets the font color.
*
* For export, the color can be specified in any valid HTML format like
* 6-character dash notation or rgb/rgba/hsl/hsla functional form. In case
* of rgba/hsla representations, specified alpha channel value
* is ignored.
*
* For import, a value is always represented in the HTML 6-character
* dash notation, for example, "#afbfcf".
*/
color?: string;
}
/**
* Workbook cell outline definition.
*/
export interface IWorkbookBorder {
/**
* Top border setting.
*/
top?: IWorkbookBorderSetting;
/**
* Bottom border setting.
*/
bottom?: IWorkbookBorderSetting;
/**
* Left border setting.
*/
left?: IWorkbookBorderSetting;
/**
* Right border setting.
*/
right?: IWorkbookBorderSetting;
/**
* Diagonal border setting.
*/
diagonal?: IWorkbookBorderSetting;
}
/**
* Border style definition
*/
export interface IWorkbookBorderSetting {
/**
* Border color.
*
* For export, the color can be specified in any valid HTML format like
* 6-character dash notation or rgb/rgba/hsl/hsla functional form. In case
* of rgba/hsla representations, specified alpha channel value
* is ignored.
*
* For import, a value is always represented in the HTML 6-character
* dash notation, for example, "#afbfcf".
*/
color?: string;
/**
* Border type.
*/
style?: BorderStyle;
}
/**
* Represents the Workbook Object Model background fill definition.
*/
export interface IWorkbookFill {
/**
* Gets or sets the fill color.
*
* For export, the color can be specified in any valid HTML format like
* 6-character dash notation or rgb/rgba/hsl/hsla functional form. In case
* of rgba/hsla representations, specified alpha channel value
* is ignored.
*
* For import, a value is always represented in the HTML 6-character
* dash notation, for example, "#afbfcf".
*/
color?: string;
}
export interface ITableIndex {
row: number;
col: number;
absCol: boolean;
absRow: boolean;
}
/**
* Defines a cell index with zero-based row and column components,
* as well as the properties indicating whether the index component
* is absolute (for example: "$D") or relative (for example: "D").
*
* It is not related with the WorkbookTable any more.
* It is a zero-based row/column indices pair that stores the converted Excel's alphanumeric cell.
*/
export interface ITableAddress {
/**
* A zero-based row index.
*/
row: number;
/**
* A zero-based column index.
*/
col: number;
/**
* Indicates whether the original column index is absolute (for example: "$D")
* or relative (for example: "D").
*/
absCol: boolean;
/**
* Indicates whether the original row index is absolute (for example: "$15")
* or relative (for example: "15").
*/
absRow: boolean;
}
/**
* Represents the Defined name definition.
*/
export interface IDefinedName {
/**
* The name of the defined name item.
*/
name: string;
/**
* The value of the defined name item.
* The value could be a formula, a string constant or a cell range.
* For e.g. "Sum(1, 2, 3)", "test" or "sheet1!A1:B2"
*/
value: any;
/**
* Indicates the defined name item works in which sheet.
* If omitted, the defined name item works in workbook.
*/
sheetName?: string;
}
/**
* Represents the Table definition.
*/
export interface IWorkbookTable {
/**
* The name of the table. It is used to reference the table programmatically.
*/
name: string;
/**
* The range on the relevant sheet that the table occupies expressed using A1 style referencing. i.e. "A1:D4".
* The reference shall include the totals row if it is shown.
*/
range: string;
/**
* Indicates whether show the header row for the table.
*/
showHeaderRow: boolean;
/**
* Indicates whether show the total row for the table.
*/
showTotalRow: boolean;
/**
* Indicating whether banded column formatting is applied.
*/
showBandedColumns: boolean;
/**
* The table style to use with the table.
*/
style: IWorkbookTableStyle;
/**
* Indicating whether banded row formatting is applied.
*/
showBandedRows: boolean;
/**
* Indicating whether the first column in the table should have the style applied.
*/
alterFirstColumn: boolean;
/**
* Indicating whether the last column in the table should have the style applied.
*/
alterLastColumn: boolean;
/**
* The columns of the table.
*/
columns: IWorkbookTableColumn[];
}
export interface _IWorkbookTable extends IWorkbookTable {
fileName?: string;
}
/**
* Represents the Table Column definition.
*/
export interface IWorkbookTableColumn {
/**
* The name of the table column. It is referenced through functions.
*/
name: string;
/**
* The string to show in the totals row cell for the column.
*/
totalRowLabel?: string;
/**
* The function to show in the totals row cell for this column.
*/
totalRowFunction?: string;
/**
* Indicating whether show filter button for the column.
*/
showFilterButton?: boolean;
}
/**
* Represents the Table Style definition.
*/
export interface IWorkbookTableStyle {
/**
* The name of the table style.
*/
name: string;
/**
* The whole table style.
*/
wholeTableStyle?: IWorkbookTableCommonStyle;
/**
* The first column stripe style.
*/
firstBandedColumnStyle?: IWorkbookTableBandedStyle;
/**
* The second column stripe style.
*/
secondBandedColumnStyle?: IWorkbookTableBandedStyle;
/**
* The first row stripe style.
*/
firstBandedRowStyle?: IWorkbookTableBandedStyle;
/**
* The second row stripe style.
*/
secondBandedRowStyle?: IWorkbookTableBandedStyle;
/**
* The first column style.
*/
firstColumnStyle?: IWorkbookTableCommonStyle;
/**
* The last column style.
*/
lastColumnStyle?: IWorkbookTableCommonStyle;
/**
* The header row style.
*/
headerRowStyle?: IWorkbookTableCommonStyle;
/**
* The total row style.
*/
totalRowStyle?: IWorkbookTableCommonStyle;
/**
* The first cell style in the header row.
*/
firstHeaderCellStyle?: IWorkbookTableCommonStyle;
/**
* The last cell style in the header row.
*/
lastHeaderCellStyle?: IWorkbookTableCommonStyle;
/**
* The first cell style in the total row.
*/
firstTotalCellStyle?: IWorkbookTableCommonStyle;
/**
* The last cell style in the total row.
*/
lastTotalCellStyle?: IWorkbookTableCommonStyle;
}
/**
* Represents the Table Common Style definition.
*/
export interface IWorkbookTableCommonStyle extends IWorkbookStyle {
/**
* Table borders setting.
*/
borders?: IWorkbookTableBorder;
}
/**
* Represents the Table Stripe Style definition.
*/
export interface IWorkbookTableBandedStyle extends IWorkbookTableCommonStyle {
/**
* Number of rows or columns in a single band of striping.
*/
size?: number;
}
/**
* Table border definition.
*/
export interface IWorkbookTableBorder extends IWorkbookBorder {
/**
* Vertical border setting.
*/
vertical?: IWorkbookBorderSetting;
/**
* Horizontal border setting.
*/
horizontal?: IWorkbookBorderSetting;
}
/**
* Piece of text run for rich text.
*/
export interface IWorkbookTextRun {
/**
* The font of the text run.
*/
font?: IWorkbookFont;
/**
* The text of the text run.
*/
text: string;
}
/**
* Defines the Workbook Object Model horizontal text alignment.
*/
export declare enum HAlign {
/** Alignment depends on the cell value type. */
General = 0,
/** Text is aligned to the left. */
Left = 1,
/** Text is centered. */
Center = 2,
/** Text is aligned to the right. */
Right = 3,
/** Text is replicated to fill the whole cell width. */
Fill = 4,
/** Text is justified. */
Justify = 5
}
/**
* Vertical alignment
*/
export declare enum VAlign {
/** Top vertical alignment */
Top = 0,
/** Center vertical alignment */
Center = 1,
/** Bottom vertical alignment */
Bottom = 2,
/** Justified vertical alignment */
Justify = 3
}
export declare enum TextDirection {
/**
* Text direction is context dependent.
*/
Context = 0,
/**
* Text direction is from left to right.
*/
LeftToRight = 1,
/**
* Text direction is from right to left.
*/
RightToLeft = 2
}
export declare enum TextOrientation {
/**
* Orientates text horizontally.
*/
Horizontal = 0,
/**
* Orientates text vertically.
*/
Vertical = 1,
/**
* Rotates text 90 degrees counterclockwise.
*/
RotateUp = 2,
/**
* Rotates text 90 degrees clockwise.
*/
RotateDown = 3
}
/**
* Border line style
*/
export declare enum BorderStyle {
/** No border */
None = 0,
/** Thin border */
Thin = 1,
/** Medium border */
Medium = 2,
/** Dashed border */
Dashed = 3,
/** Dotted border */
Dotted = 4,
/** Thick line border */
Thick = 5,
/** Double line border */
Double = 6,
/** Hair line border */
Hair = 7,
/** Medium dashed border */
MediumDashed = 8,
/** Thin dash dotted border */
ThinDashDotted = 9,
/** Medium dash dotted border */
MediumDashDotted = 10,
/** Thin dash dot dotted border */
ThinDashDotDotted = 11,
/** Medium dash dot dotted border */
MediumDashDotDotted = 12,
/** Slanted medium dash dotted border */
SlantedMediumDashDotted = 13
}
/**
* NOTE: This function is OBSOLETE and retained for compatibility.
* It is no longer needed because wijmo.xlsx module loads
* jszip module automatically. You should only ensure that jszip module is installed in
* your application.
*
* Defines a reference to JSZip module that will be used by the Wijmo xlsx export modules.
*
* This method should be used in npm modules based applications to provide wijmo.xlsx module
* with a reference to the JSZip module retrieved using the ES6 import statement. For example:
* import * as JSZip from 'jszip';
* import * as wjcXlsx from 'wijmo/wijmo.xlsx';
* wjcXlsx.useJSZip(JSZip);
*
*
* @param jszip Reference to the JSZip constructor function.
*/
export declare function useJSZip(jszip: any): void;
export declare class _xlsx {
private static _alphabet;
private static _alphabetMap;
private static _indexedColors;
private static _numFmts;
private static _tableColumnFunctions;
private static _xmlDescription;
private static _workbookNS;
private static _relationshipsNS;
private static _defaultFontName;
private static _defaultFontSize;
private static _macroEnabled;
private static _sharedStrings;
static readonly _defaultColorThemes: string[];
private static _colorThemes;
private static _styles;
private static _sharedFormulas;
private static _borders;
private static _fonts;
private static _fills;
private static _contentTypes;
private static _props;
private static _xlRels;
private static _worksheets;
private static _tableStyles;
private static _dxfs;
private static _tables;
private static _notes;
static load(data: string | ArrayBuffer, includeStyles?: boolean): IWorkbook;
static loadAsync(data: string | ArrayBuffer, includeStyles?: boolean): any;
static save(workbook: IWorkbook): any;
static saveAsync(workbook: IWorkbook, cs: _ICancellationSource, onError?: (reason?: any) => any, onProgress?: (value: number) => void): selfModule._SyncPromise;
private static _loadImpl;
private static _readNotes;
private static _saveWorkbookToZip;
private static _writeNotes;
private static _generateWorksheets;
private static _getSharedString;
private static _extractTextRuns;
private static _getInlineString;
private static _asciiCtrlReplacements;
private static _escape;
private static _unescape;
private static _unescapeNumericEntities;
private static _getCoreSetting;
private static _getWorkbook;
private static _getTheme;
private static _getStyle;
private static _getEdgeBorder;
private static _getSheet;
private static _getTable;
private static _getTableColumn;
private static _getSheetRelatedTable;
private static _getSheetRelatedHyperlink;
private static _getTableStyles;
private static _getTableStyleElement;
private static _getTableStyleByName;
private static _getHyperlink;
private static _getTextRunFont;
private static _getTextOfTextRuns;
private static _isBuiltInStyleName;
private static _generateRelsDoc;
private static _generateThemeDoc;
private static _generateClrScheme;
private static _generateFontScheme;
private static _generateFmtScheme;
private static _generateFillScheme;
private static _generateLineStyles;
private static _generateEffectScheme;
private static _generateBgFillScheme;
private static _generateCoreDoc;
private static _generateSheetGlobalSetting;
private static _generateCell;
private static _generateMergeSetting;
private static _generateStyleDoc;
private static _generateBorderStyle;
private static _generateFontStyle;
private static _generateFillStyle;
private static _generateCellXfs;
private static _generateContentTypesDoc;
private static _generateAppDoc;
private static _generateWorkbookRels;
private static _generateWorkbook;
private static _generateWorksheetRows;
private static _generateWorkSheet;
private static _generateWorksheetColumn;
private static _generateSharedStringsDoc;
private static _generateTextRuns;
private static _generatePlainText;
private static _generateTable;
private static _generateTableFilterSetting;
private static _generateHyperlinkRel;
private static _getDxfs;
private static _generateDxfs;
private static _generateTableStyles;
private static _isEmptyStyleEle;
private static _getTableFileName;
private static _getColor;
private static _getThemeColor;
private static _parsedColors;
private static _parseColor;
private static _getsBaseSharedFormulas;
private static _parseSharedFormulaInfo;
private static _getSharedFormula;
private static _convertDate;
private static _parseBorder;
private static _applyDefaultBorder;
private static _resolveStyleInheritance;
static _parsePixelToCharWidth(pixels: any): number;
private static _parseCharWidthToPixel;
private static _parseCharCountToCharWidth;
private static _numAlpha;
private static _alphaNum;
private static _typeOf;
private static _extend;
private static _isEmpty;
private static _cloneStyle;
private static _cloneColumnsStyle;
private static _getSheetIndex;
private static _checkRangeForIntersections;
private static _getAttr;
private static _getSharedStyle;
private static _getChildNodeValue;
private static _getElementValue;
private static _getSubElement;
private static _getSheetIndexBySheetName;
private static _sheetHasNotes;
private static _collectNotes;
}
export interface _ISyncPromiseCallback {
onFulfilled?: (value?: any) => any;
onRejected?: (reason?: any) => any;
}
export interface _ICancellationSource {
cancelled: boolean;
cancel(): void;
}
export declare class _SyncPromise implements _ISyncPromiseCallback, _ICancellationSource {
static serial(cs: _ICancellationSource, promises: (() => _SyncPromise)[]): _SyncPromise;
private _callbacks;
private _resolved;
private _cs;
private _onCancel;
private _cancelled;
constructor(cs?: _ICancellationSource, onCancel?: Function);
cancel(raiseEvent?: boolean): void;
readonly cancelled: boolean;
then(onFulfilled?: (value?: any) => any, onRejected?: (reason?: any) => any): this;
catch(onRejected: (reason?: any) => any): _SyncPromise;
resolve(value?: any): this;
reject(reason?: any): this;
onFulfilled(value: any): void;
onRejected(reason: any): void;
}
export declare function _map(value: number, minIn: number, maxIn: number, minOut: number, maxOut: number): number;