Interface XlsxStreamReaderWorkBook
interface XlsxStreamReaderWorkBook {
abortBook: boolean;
formatCodes: { [key: string]: any };
hasFormatCodes: boolean;
options: OpenXlsxOptions;
parsedSharedStrings: boolean;
ready: Promise<void>;
source: UnpackArchiveResult;
waitingWorkSheets: {
name: string;
path: string;
sheetNo: string;
sheetPath: string;
}[];
workBookInfo: WorkBookInfo;
workBookSharedStrings: any[];
workBookStyles: any[];
xfs: any;
_getSharedString(stringIndex: number): any;
_getSheetName(sheetPath: string): string;
_parseSharedStrings(nodeData: any[]): void;
_parseStyles(nodeData: any[]): void;
_parseWorkBookInfo(nodeData: any[], workBookInfo: WorkBookInfo): void;
_parseWorkBookRels(nodeData: any[], workBookInfo: WorkBookInfo): void;
_parseXML(
entry: UnpackArchiveDirectory | UnpackArchiveFile,
entryHandler: (this: XlsxStreamReaderWorkBook, node: any) => void,
__namedParameters?: { trim: boolean },
): Promise<void>;
abort(): void;
end(): XlsxStreamReaderWorkBook;
getFormat(numFmt: number): any;
getSheets(): { name: string; sheetPath: string }[];
openSheet(sheet: string | number): XlsxStreamReaderWorkSheet;
readyForStreaming(): Promise<void>;
write(): boolean;
}
abortBook: boolean;
formatCodes: { [key: string]: any };
hasFormatCodes: boolean;
options: OpenXlsxOptions;
parsedSharedStrings: boolean;
ready: Promise<void>;
source: UnpackArchiveResult;
waitingWorkSheets: {
name: string;
path: string;
sheetNo: string;
sheetPath: string;
}[];
workBookInfo: WorkBookInfo;
workBookSharedStrings: any[];
workBookStyles: any[];
xfs: any;
_getSharedString(stringIndex: number): any;
_getSheetName(sheetPath: string): string;
_parseSharedStrings(nodeData: any[]): void;
_parseStyles(nodeData: any[]): void;
_parseWorkBookInfo(nodeData: any[], workBookInfo: WorkBookInfo): void;
_parseWorkBookRels(nodeData: any[], workBookInfo: WorkBookInfo): void;
_parseXML(
entry: UnpackArchiveDirectory | UnpackArchiveFile,
entryHandler: (this: XlsxStreamReaderWorkBook, node: any) => void,
__namedParameters?: { trim: boolean },
): Promise<void>;
abort(): void;
end(): XlsxStreamReaderWorkBook;
getFormat(numFmt: number): any;
getSheets(): { name: string; sheetPath: string }[];
openSheet(sheet: string | number): XlsxStreamReaderWorkSheet;
readyForStreaming(): Promise<void>;
write(): boolean;
}
Index
Properties
Methods
Properties
abort Book
abortBook: boolean
format Codes
formatCodes: { [key: string]: any }
has Format Codes
hasFormatCodes: boolean
options
parsed Shared Strings
parsedSharedStrings: boolean
ready
ready: Promise<void>
source
waiting Work Sheets
waitingWorkSheets: {
name: string;
path: string;
sheetNo: string;
sheetPath: string;
}[]
name: string;
path: string;
sheetNo: string;
sheetPath: string;
}[]
work Book Info
workBookInfo: WorkBookInfo
work Book Shared Strings
workBookSharedStrings: any[]
work Book Styles
workBookStyles: any[]
xfs
xfs: any
Methods
_ get Shared String
Parameters
- stringIndex: number
Returns any
_ get Sheet Name
Parameters
- sheetPath: string
Returns string
_ parse Shared Strings
Parameters
- nodeData: any[]
Returns void
_ parse Styles
Parameters
- nodeData: any[]
Returns void
_ parse Work Book Info
Parameters
- nodeData: any[]
- workBookInfo: WorkBookInfo
Returns void
_ parse Work Book Rels
Parameters
- nodeData: any[]
- workBookInfo: WorkBookInfo
Returns void
_ parse XML
- _parseXML(
entry: UnpackArchiveDirectory | UnpackArchiveFile,
entryHandler: (this: XlsxStreamReaderWorkBook, node: any) => void,
__namedParameters?: { trim: boolean },
): Promise<void>Parameters
- entry: UnpackArchiveDirectory | UnpackArchiveFile
- entryHandler: (this: XlsxStreamReaderWorkBook, node: any) => void
- __namedParameters: { trim: boolean } = ...
Returns Promise<void>
abort
Returns void
end
Returns XlsxStreamReaderWorkBook
get Format
Parameters
- numFmt: number
Returns any
get Sheets
Returns { name: string; sheetPath: string }[]
open Sheet
Parameters
- sheet: string | number
Sheet index (0-based) or name
Returns XlsxStreamReaderWorkSheet
- sheet: string | number
ready For Streaming
Returns Promise<void>
write
Returns boolean
Open a sheet