excel-builder-vanilla

// Generated by dts-bundle-generator v9.5.1 import { ZipOptions } from 'fflate'; export type XMLNodeOption = { attributes?: { [key: string]: any; }; children?: XMLNode[]; nodeName: string; nodeValue?: string; type?: string; }; export declare class XMLDOM { documentElement: XMLNode; constructor(ns: string | null, rootNodeName: string); createElement(name: string): XMLNode; createTextNode(text: string): TextNode; toString(): string; static Node: { Create: (config: any) => XMLNode | TextNode | null; }; } declare class TextNode { nodeValue: any; constructor(text: string); toJSON(): { nodeValue: any; type: string; }; toString(): string; } export declare class XMLNode { readonly nodeName: string; readonly children: XMLNode[]; nodeValue: string; attributes: { [key: string]: any; }; firstChild?: XMLNode; constructor(config: XMLNodeOption); toString(): string; toJSON(): { nodeName: string; children: any[]; nodeValue: string; attributes: { [key: string]: any; }; type: string; }; setAttribute(name: string, val: any): void; appendChild(child: any): void; cloneNode(_deep?: boolean): XMLNode; } /** * * @param {Object} config * @param {Number} config.x The cell column number that the top left of the picture will start in * @param {Number} config.y The cell row number that the top left of the picture will start in * @param {Number} config.width Width in EMU's * @param {Number} config.height Height in EMU's * @constructor */ export declare class OneCellAnchor { x: number | null; y: number | null; xOff: boolean | null; yOff: boolean | null; width: number | null; height: number | null; constructor(config: AnchorOption); setPos(x: number, y: number, xOff?: boolean, yOff?: boolean): void; setDimensions(width: number, height: number): void; toXML(xmlDoc: XMLDOM, content: any): XMLNode; } export declare class TwoCellAnchor { from: any; to: any; constructor(config: DualAnchorOption); setFrom(x: number, y: number, xOff?: boolean, yOff?: boolean): void; setTo(x: number, y: number, xOff?: boolean, yOff?: boolean): void; toXML(xmlDoc: XMLDOM, content: any): XMLNode; } export interface AnchorOption { /** X offset in EMUs (English Metric Units) */ x: number; /** Y offset in EMUs (English Metric Units) */ y: number; /** Optional: X offset as boolean (for cell anchoring) */ xOff?: boolean; /** Optional: Y offset as boolean (for cell anchoring) */ yOff?: boolean; /** Width in EMUs */ width?: number; /** Height in EMUs */ height?: number; /** Reference to parent Drawing instance */ drawing?: Drawing; } export interface DualAnchorOption { /** Ending anchor position (AnchorOption) */ to: AnchorOption; /** Starting anchor position (AnchorOption) */ from: AnchorOption; /** Reference to parent Drawing instance */ drawing?: Drawing; } /** * This is mostly a global spot where all of the relationship managers can get and set * path information from/to. * @module Excel/Drawing */ export declare class Drawing { anchor: AbsoluteAnchor | OneCellAnchor | TwoCellAnchor; id: string; /** * * @param {String} type Can be 'absoluteAnchor', 'oneCellAnchor', or 'twoCellAnchor'. * @param {Object} config Shorthand - pass the created anchor coords that can normally be used to construct it. * @returns {Anchor} */ createAnchor(type: "absoluteAnchor" | "oneCellAnchor" | "twoCellAnchor", config: Partial<AnchorOption | DualAnchorOption>): AbsoluteAnchor | OneCellAnchor | TwoCellAnchor; } /** * * @param {Object} config * @param {Number} config.x X offset in EMU's * @param {Number} config.y Y offset in EMU's * @param {Number} config.width Width in EMU's * @param {Number} config.height Height in EMU's * @constructor */ export declare class AbsoluteAnchor { x: number | null; y: number | null; width: number | null; height: number | null; constructor(config: AnchorOption); /** * Sets the X and Y offsets. * * @param {Number} x * @param {Number} y * @returns {undefined} */ setPos(x: number, y: number): void; /** * Sets the width and height of the image. * * @param {Number} width * @param {Number} height * @returns {undefined} */ setDimensions(width: number, height: number): void; toXML(xmlDoc: XMLDOM, content: any): XMLNode; } /** * Excel Color in ARGB format, for color aren't transparent just use "FF" as prefix. * For example if the color you want to add is a blue with HTML color "#0000FF", then the excel color we need to add is "FF0000FF" * Online tool: https://www.myfixguide.com/color-converter/ */ export type ExcelColorStyle = string | { theme: number; }; export type BorderStyle = { style?: string; color?: string | { theme: number; [key: string]: any; }; }; export interface BorderInstruction { top?: BorderStyle; left?: BorderStyle; right?: BorderStyle; bottom?: BorderStyle; diagonal?: BorderStyle; outline?: boolean; diagonalUp?: boolean; diagonalDown?: boolean; id?: number; } export interface ExcelAlignmentStyle { /** Horizontal alignment of cell content */ horizontal?: "center" | "fill" | "general" | "justify" | "left" | "right"; /** Justify last line (for justified alignment) */ justifyLastLine?: boolean; /** Reading order (1 = LTR, 2 = RTL) */ readingOrder?: 1 | 2; /** Indent cell content (number of spaces) */ indent?: number; /** Shrink text to fit cell */ shrinkToFit?: boolean; /** Text rotation angle or preset */ textRotation?: string | number; /** Vertical alignment of cell content */ vertical?: "bottom" | "distributed" | "center" | "justify" | "top"; /** Wrap text within cell */ wrapText?: boolean; } export type ExcelBorderLineStyle = "continuous" | "dash" | "dashDot" | "dashDotDot" | "dotted" | "double" | "none" | "medium" | "slantDashDot" | "thin" | "thick"; export interface ExcelBorderStyle { /** Bottom border configuration */ bottom?: { color?: ExcelColorStyle; style?: ExcelBorderLineStyle; }; /** Top border configuration */ top?: { color?: ExcelColorStyle; style?: ExcelBorderLineStyle; }; /** Left border configuration */ left?: { color?: ExcelColorStyle; style?: ExcelBorderLineStyle; }; /** Right border configuration */ right?: { color?: ExcelColorStyle; style?: ExcelBorderLineStyle; }; /** Diagonal border configuration */ diagonal?: { color?: ExcelColorStyle; style?: ExcelBorderLineStyle; }; /** Outline border (all sides) */ outline?: boolean; /** Diagonal up border */ diagonalUp?: boolean; /** Diagonal down border */ diagonalDown?: boolean; } export interface ExcelColumn { /** Auto-fit column width to content */ bestFit?: boolean; /** Collapse grouped columns */ collapsed?: boolean; /** Custom column width */ customWidth?: number; /** Hide column from view */ hidden?: boolean; /** Maximum column index for this config */ max?: number; /** Minimum column index for this config */ min?: number; /** Outline level for grouping */ outlineLevel?: number; /** Enable phonetic guide (East Asian languages) */ phonetic?: boolean; /** Style ID for column */ style?: number; /** Column width in Excel units */ width?: number; } export interface ExcelTableColumn { /** Column display name */ name: string; /** Style for data cells in this column */ dataCellStyle?: ExcelStyleInstruction; /** Differential style ID for data cells */ dataDxfId?: number; /** Style for header row cell */ headerRowCellStyle?: ExcelStyleInstruction; /** Differential style ID for header row */ headerRowDxfId?: number; /** Style for totals row cell */ totalsRowCellStyle?: ExcelStyleInstruction; /** Differential style ID for totals row */ totalsRowDxfId?: number; /** Function for totals row (e.g. SUM, COUNT) */ totalsRowFunction?: string; /** Label for totals row cell */ totalsRowLabel?: string; /** Formula for column values */ columnFormula?: string; /** Is column formula an array formula? */ columnFormulaIsArrayType?: boolean; /** Formula for totals row */ totalFormula?: string; /** Is totals formula an array formula? */ totalFormulaIsArrayType?: boolean; } export interface ExcelFillStyle { /** Fill type: gradient or pattern */ type?: "gradient" | "pattern"; /** Pattern type (if pattern fill) */ patternType?: string; /** Gradient angle (if gradient fill) */ degree?: number; /** Foreground color for fill */ fgColor?: ExcelColorStyle; /** Gradient start color */ start?: ExcelColorStyle; /** Gradient end color and position */ end?: { pureAt?: number; color?: ExcelColorStyle; }; } export interface ExcelFontStyle { /** Bold text */ bold?: boolean; /** Font color */ color?: ExcelColorStyle; /** Font family name */ fontName?: string; /** Italic text */ italic?: boolean; /** Outline font effect */ outline?: boolean; /** Font size in points */ size?: number; /** Shadow effect */ shadow?: boolean; /** Strikethrough text */ strike?: boolean; /** Subscript text */ subscript?: boolean; /** Superscript text */ superscript?: boolean; /** Underline style */ underline?: boolean | "single" | "double" | "singleAccounting" | "doubleAccounting"; } export interface ExcelMetadata { /** Type of metadata (custom usage) */ type?: string; /** Style ID for metadata */ style?: number; } export interface ExcelColumnMetadata { /** Cell value */ value: string | number | boolean | Date | null; /** Optional metadata for the value */ metadata?: ExcelMetadata; } export interface ExcelMargin { /** Top margin in inches */ top: number; /** Bottom margin in inches */ bottom: number; /** Left margin in inches */ left: number; /** Right margin in inches */ right: number; /** Header margin in inches */ header: number; /** Footer margin in inches */ footer: number; } export interface ExcelSortState { /** Is sort case sensitive? */ caseSensitive?: boolean; /** Data range to sort */ dataRange?: string; /** Sort by column (true) or row (false) */ columnSort?: boolean; /** Sort direction: ascending or descending */ sortDirection?: "ascending" | "descending"; /** Range to sort (defaults to dataRange) */ sortRange?: string; } /** Excel custom formatting that will be applied to a column */ export interface ExcelStyleInstruction { /** Unique style instruction ID (internal use) */ id?: number; /** Cell alignment style (horizontal, vertical, wrap, etc.) */ alignment?: ExcelAlignmentStyle; /** Cell border style or border style ID */ border?: ExcelBorderStyle | number; /** Border style ID (if referencing a shared style) */ borderId?: number; /** Cell fill style (pattern, gradient, color) or fill style ID */ fill?: ExcelFillStyle | number; /** Fill style ID (if referencing a shared style) */ fillId?: number; /** Cell font style (bold, italic, color, etc.) or font style ID */ font?: ExcelFontStyle | number; /** Font style ID (if referencing a shared style) */ fontId?: number; /** Custom cell format string or format ID (e.g., date, currency) */ format?: string | number; /** Row height in points (if set at row level) */ height?: number; /** Number format string (Excel format codes) */ numFmt?: string; /** Number format ID (if referencing a shared format) */ numFmtId?: number; /** Column width in Excel units (if set at column level) */ width?: number; /** Extended format ID (Open XML xfId, for advanced style referencing) */ xfId?: number; /** Cell protection settings (locked, hidden) */ protection?: { locked?: boolean; hidden?: boolean; }; /** Style ID (if referencing a shared style) */ style?: number; } export type ChartType = "column" | "bar" | "line" | "pie" | "doughnut" | "scatter"; /** Axis configuration options */ export interface AxisOptions { /** Axis title label */ title?: string; /** Explicit minimum value (value axis only; ignored for category axis unless future numeric category support) */ minimum?: number; /** Explicit maximum value (value axis only) */ maximum?: number; /** Show major gridlines */ showGridLines?: boolean; } export interface ChartSeriesRef { /** Series display name */ name: string; /** Cell range for series values (e.g. `Sheet1!$B$2:$B$5`) */ valuesRange: string; /** * Optional solid color for the series. Use opaque ARGB `FFRRGGBB` (e.g. FF3366CC). * Alpha (other than FF) currently ignored. Theme colors not yet supported for charts. */ color?: string; /** Scatter only: per-series X axis numeric range (ignored for non-scatter charts) */ scatterXRange?: string; } /** Legend configuration (minimal) */ export interface LegendOptions { /** Force show (true) or hide (false). If undefined, auto: show only when multiple series */ show?: boolean; /** Legend position (defaults to 'right' if omitted) */ position?: "right" | "left" | "top" | "bottom" | "topRight"; /** Overlay the legend on the plot area (no space reservation) */ overlay?: boolean; } export interface ChartOptions { /** Chart type (defaults to 'column' if omitted) */ type?: ChartType; /** Chart title shown above plot area */ title?: string; /** Axis configuration (ignored for pie except title for completeness) */ axis?: { /** Category/X axis options */ x?: AxisOptions; /** Value/Y axis options */ y?: AxisOptions; }; /** Width in EMUs */ width?: number; /** Height in EMUs */ height?: number; /** Categories range (for non-scatter) e.g. Sheet1!$A$2:$A$5 */ categoriesRange?: string; /** Stacking mode for supported chart types (column, bar, line). 'stacked' for cumulative, 'percent' for 100% scaling. Undefined => no stacking */ stacking?: "stacked" | "percent"; /** Multi-series cell references */ series?: ChartSeriesRef[]; /** Legend configuration */ legend?: LegendOptions; /** Global data label toggles (applies to the whole chart). If any flag true a <c:dLbls> node is emitted. */ dataLabels?: { /** Show numerical value */ showValue?: boolean; /** Show category text (for non-scatter) */ showCategory?: boolean; /** Show percentage (mainly useful for pie/doughnut or percent stacked) */ showPercent?: boolean; /** Show series name (useful when multiple series and category/value alone is ambiguous) */ showSeriesName?: boolean; }; } /** * @module Excel/Util */ export declare class Util { static _idSpaces: { [space: string]: number; }; /** * Returns a number based on a namespace. So, running with 'Picture' will return 1. Run again, you will get 2. Run with 'Foo', you'll get 1. * @param {String} space * @returns {Number} */ static uniqueId(space: string): number; /** * Attempts to create an XML document. After some investigation, using the 'fake' document * is significantly faster than creating an actual XML document, so we're going to go with * that. Besides, it just makes it easier to port to node. * * Takes a namespace to start the xml file in, as well as the root element * of the xml file. * * @param {type} ns * @param {type} base * @returns {@new;XMLDOM} */ static createXmlDoc(ns: string, base: string): XMLDOM; /** * Creates an xml node (element). Used to simplify some calls, as IE is * very particular about namespaces and such. * * @param {XMLDOM} doc An xml document (actual DOM or fake DOM, not a string) * @param {type} name The name of the element * @param {type} attributes * @returns {XML Node} */ static createElement(doc: XMLDOM, name: string, attributes?: any): XMLNode; /** * This is sort of slow, but it's a huge convenience method for the code. It probably shouldn't be used * in high repetition areas. * * @param {XMLDoc} doc * @param {Object} attrs */ static setAttributesOnDoc(doc: XMLNode, attrs: { [key: string]: any; }): void; static LETTER_REFS: any; static positionToLetterRef(x: number, y: number | string): any; static schemas: { worksheet: string; sharedStrings: string; stylesheet: string; relationships: string; relationshipPackage: string; contentTypes: string; spreadsheetml: string; markupCompat: string; x14ac: string; officeDocument: string; package: string; table: string; spreadsheetDrawing: string; drawing: string; drawingRelationship: string; image: string; chart: string; hyperlink: string; }; } /** * Minimal Chart implementation (clustered column) required for Excel to render without repair. * This produces 2 parts: * 1) Drawing graphicFrame (returned by toXML for inclusion in `/xl/drawings/drawingN.xml`) * 2) Chart part XML (returned by toChartSpaceXML for inclusion in `/xl/charts/chartN.xml`) * Relationships: * `drawingN.xml.rels` -> `../charts/chartN.xml` (Type chart) */ export declare class Chart extends Drawing { relId: string | null; index: number | null; target: string | null; options: ChartOptions; constructor(options: ChartOptions); /** Return relationship type for this drawing */ getMediaType(): keyof typeof Util.schemas; /** RelationshipManager calls this via Drawings */ setRelationshipId(rId: string): void; /** Drawing part representation (inside an anchor) */ toXML(xmlDoc: XMLDOM): XMLNode; /** Chart part XML: `/xl/charts/chartN.xml` */ toChartSpaceXML(): XMLDOM; /** @private Creates the graphicFrame container that goes inside an anchor in drawing part */ _createGraphicFrame(xmlDoc: XMLDOM): XMLNode; /** @private Create the primary chart node based on type and stacking */ _createPrimaryChartNode(doc: XMLDOM, type: string, stacking?: "stacked" | "percent"): XMLNode; /** @private Build a <c:ser> node */ _createSeriesNode(doc: XMLDOM, s: { name: string; valuesRange: string; scatterXRange?: string; color?: string; }, idx: number, type: string, categoriesRange: string): XMLNode; /** @private Apply a basic series color if provided. Supports RGB (RRGGBB) or ARGB (AARRGGBB); leading # optional. Alpha (if provided) is stripped. */ _applySeriesColor(doc: XMLDOM, serNode: XMLNode, type: string, color?: string): void; /** @private Create legend node honoring position + overlay */ _createLegendNode(doc: XMLDOM, legendOpts?: { position?: string; overlay?: boolean; }): XMLNode; /** @private Create a c:title node with minimal rich text required for Excel to render */ _createTitleNode(doc: XMLDOM, text: string): XMLNode; /** @private Create a category axis (catAx) */ _createCategoryAxis(doc: XMLDOM, axId: number, crossAx: number, title?: string, opts?: { showGridLines?: boolean; }): XMLNode; /** @private Create a value axis (valAx) */ _createValueAxis(doc: XMLDOM, axId: number, crossAx: number, pos: "l" | "b", title?: string, opts?: { minimum?: number; maximum?: number; showGridLines?: boolean; }): XMLNode; /** @private Simple axis id base using index plus a constant offset */ _nextAxisIdBase(): number; /** @private Resolve grouping value based on chart type and stacking */ _resolveGrouping(type: string, stacking?: "stacked" | "percent"): string; } export type Relation = { [id: string]: { id: string; schema: string; object: { id: string; target?: string | null; targetMode?: string; [key: string]: any; }; data?: { id: number; schema: string; object: any; }; }; }; /** * @module Excel/RelationshipManager */ export declare class RelationshipManager { relations: Relation; lastId: number; constructor(); importData(data: { relations: Relation; lastId: number; }): void; exportData(): { relations: Relation; lastId: number; }; addRelation(object: { id: string; target?: string | null; targetMode?: string; }, type: keyof typeof Util.schemas): string; getRelationshipId(object: { id: string; target?: string | null; targetMode?: string; }): string | null; toXML(): XMLDOM; } /** * @module Excel/Drawings */ export declare class Drawings { drawings: Drawing[]; relations: RelationshipManager; id: string; /** * Adds a drawing (more likely a subclass of a Drawing) to the 'Drawings' for a particular worksheet. * * @param {Drawing} drawing * @returns {undefined} */ addDrawing(drawing: Drawing): void; getCount(): number; toXML(): XMLDOM; } /** * @module Excel/SharedStrings */ export declare class SharedStrings { strings: { [key: string]: number; }; stringArray: string[]; id: string; /** * Adds a string to the shared string file, and returns the ID of the * string which can be used to reference it in worksheets. * * @param str {String} * @return int */ addString(str: string): number; exportData(): { [key: string]: number; }; toXML(): XMLDOM; } /** * @module Excel/StyleSheet */ declare class StyleSheet$1 { id: string; cellStyles: { name: string; xfId: string; builtinId: string; }[]; defaultTableStyle: boolean; differentialStyles: any[]; masterCellFormats: any[]; masterCellStyles: any[]; fonts: ExcelFontStyle[]; numberFormatters: any[]; fills: any[]; borders: any[]; tableStyles: any[]; createSimpleFormatter(type: string): { [id: string]: number; }; createFill(fillInstructions: any): any; createNumberFormatter(formatInstructions: any): { id: number; formatCode: any; }; /** * alignment: { * horizontal: http://www.schemacentral.com/sc/ooxml/t-ssml_ST_HorizontalAlignment.html * vertical: http://www.schemacentral.com/sc/ooxml/t-ssml_ST_VerticalAlignment.html * @param {Object} styleInstructions */ createFormat(styleInstructions: ExcelStyleInstruction): any; createDifferentialStyle(styleInstructions: ExcelStyleInstruction): ExcelStyleInstruction; /** * Should be an object containing keys that match with one of the keys from this list: * http://www.schemacentral.com/sc/ooxml/t-ssml_ST_TableStyleType.html * * The value should be a reference to a differential format (dxf) * @param {Object} instructions */ createTableStyle(instructions: any): void; /** * All params optional. each border should follow: * { * style: styleString, http://www.schemacentral.com/sc/ooxml/t-ssml_ST_BorderStyle.html * color: ARBG color (requires the A, so for example FF006666) * } * @param {Object} border */ createBorderFormatter(border: BorderInstruction): BorderInstruction; /** * Font styles, color is a future goal - at the moment it's looking a bit complicated * @param {Object} instructions */ createFontStyle(instructions: ExcelFontStyle): any; exportBorders(doc: XMLDOM): XMLNode; exportBorder(doc: XMLDOM, data: any): XMLNode; exportColor(doc: XMLDOM, color: any): XMLNode; exportMasterCellFormats(doc: XMLDOM): XMLNode; exportMasterCellStyles(doc: XMLDOM): XMLNode; exportCellFormatElement(doc: XMLDOM, styleInstructions: ExcelStyleInstruction): XMLNode; exportAlignment(doc: XMLDOM, alignmentData: any): XMLNode; exportFonts(doc: XMLDOM): XMLNode; exportFont(doc: XMLDOM, fd: any): XMLNode; exportFills(doc: XMLDOM): XMLNode; exportFill(doc: XMLDOM, fd: any): XMLNode; exportGradientFill(doc: XMLDOM, data: any): XMLNode; /** * Pattern types: http://www.schemacentral.com/sc/ooxml/t-ssml_ST_PatternType.html * @param {XMLDoc} doc * @param {Object} data */ exportPatternFill(doc: XMLDOM, data: any): XMLNode; exportNumberFormatters(doc: XMLDOM): XMLNode; exportNumberFormatter(doc: XMLDOM, fd: any): XMLNode; exportCellStyles(doc: XMLDOM): XMLNode; exportDifferentialStyles(doc: XMLDOM): XMLNode; exportDFX(doc: XMLDOM, style: any): XMLNode; exportTableStyles(doc: XMLDOM): XMLNode; exportTableStyle(doc: XMLDOM, style: { name: string; wholeTable?: number; headerRow?: number; }): XMLNode; exportProtection(doc: XMLDOM, protectionData: any): XMLNode; toXML(): XMLDOM; } /** * @module Excel/Table */ export declare class Table { name: string; id: string; tableId: string; displayName: string; dataCellStyle: string | null; dataDfxId: number | null; headerRowBorderDxfId: number | null; headerRowCellStyle: string | null; headerRowCount: number; headerRowDxfId: number | null; insertRow: boolean; insertRowShift: boolean; ref: [ number[], number[] ] | null; tableBorderDxfId: number | null; totalsRowBorderDxfId: number | null; totalsRowCellStyle: string | null; totalsRowCount: number; totalsRowDxfId: number | null; tableColumns: ExcelTableColumn[]; autoFilter: [ number[], number[] ] | null; sortState: ExcelSortState | null; styleInfo: { themeStyle?: string; showFirstColumn?: boolean; showLastColumn?: boolean; showColumnStripes?: boolean; showRowStripes?: boolean; }; constructor(config?: any); initialize(config: any): void; setReferenceRange(start: number[], end: number[]): void; setTableColumns(columns: Array<ExcelTableColumn | string>): void; /** * Expects an object with the following optional properties: * name (required) * dataCellStyle * dataDxfId * headerRowCellStyle * headerRowDxfId * totalsRowCellStyle * totalsRowDxfId * totalsRowFunction * totalsRowLabel * columnFormula * columnFormulaIsArrayType (boolean) * totalFormula * totalFormulaIsArrayType (boolean) */ addTableColumn(column: ExcelTableColumn | string): void; /** * Expects an object with the following properties: * caseSensitive (boolean) * dataRange * columnSort (assumes true) * sortDirection * sortRange (defaults to dataRange) */ setSortState(state: ExcelSortState): void; toXML(): XMLDOM; exportTableColumns(doc: XMLDOM): XMLNode; exportAutoFilter(doc: XMLDOM): XMLNode; exportTableStyleInfo(doc: XMLDOM): XMLNode; addAutoFilter(startRef: any, endRef: any): void; } export declare class Pane { state: null | "split" | "frozen" | "frozenSplit"; xSplit: number | null; ySplit: number | null; activePane: string; topLeftCell: number | string | null; _freezePane: { xSplit: number; ySplit: number; cell: string; }; freezePane(column: number, row: number, cell: string): void; exportXML(doc: XMLDOM): XMLNode; } export interface SheetViewOption { pane?: Pane; } /** * @module Excel/SheetView * https://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.sheetview%28v=office.14%29.aspx * */ export declare class SheetView { pane: Pane; showZeros: boolean | null; defaultGridColor: string | null; colorId: number | null; rightToLeft: boolean | null; showFormulas: boolean | null; showGridLines: boolean | null; showOutlineSymbols: boolean | null; showRowColHeaders: boolean | null; showRuler: boolean | null; showWhiteSpace: boolean | null; tabSelected: boolean | null; topLeftCell: boolean | null; viewType: null; windowProtection: boolean | null; zoomScale: boolean | null; zoomScaleNormal: any; zoomScalePageLayoutView: any; zoomScaleSheetLayoutView: any; constructor(config?: SheetViewOption); /** * Added froze pane * @param column - column number: 0, 1, 2 ... * @param row - row number: 0, 1, 2 ... * @param cell - 'A1' * @deprecated */ freezePane(column: number, row: number, cell: string): void; exportXML(doc: XMLDOM): XMLNode; } export interface CharType { font?: string; bold?: boolean; fontSize?: number; text?: string; underline?: boolean; } export interface WorksheetOption { name?: string; sheetView?: SheetView; columns?: ExcelColumn[]; } /** * This module represents an excel worksheet in its basic form - no tables, charts, etc. Its purpose is * to hold data, the data's link to how it should be styled, and any links to other outside resources. * * @module Excel/Worksheet */ export declare class Worksheet { name: string; id: string; _timezoneOffset: number; relations: RelationshipManager | null; columnFormats: ExcelColumn[]; data: (number | string | boolean | Date | null | ExcelColumnMetadata)[][]; mergedCells: string[][]; columns: ExcelColumn[]; sheetProtection: { exportXML: (doc: XMLDOM) => XMLNode; } | false; _headers: [ left?: string | CharType | any[], center?: string | CharType | any[], right?: string | CharType | any[] ]; _footers: [ left?: string | CharType | any[], center?: string | CharType | any[], right?: string | CharType | any[] ]; _tables: Table[]; _drawings: Array<Table | Drawings>; _orientation?: string; _margin?: ExcelMargin; _rowInstructions: any; _freezePane: { xSplit?: number; ySplit?: number; cell?: string; }; sharedStrings: SharedStrings | null; hyperlinks: Array<{ cell: string; id: string; location?: string; targetMode?: string; }>; sheetView: SheetView; showZeros: any; constructor(config: WorksheetOption); initialize(config: any): void; /** * Returns an object that can be consumed by a Worksheet/Export/Worker * @returns {Object} */ exportData(): { relations: { relations: { [id: string]: { id: string; schema: string; object: { id: string; target?: string | null; targetMode?: string; [key: string]: any; }; data?: { id: number; schema: string; object: any; }; }; }; lastId: number; } | undefined; columnFormats: ExcelColumn[]; data: (string | number | boolean | Date | ExcelColumnMetadata | null)[][]; columns: ExcelColumn[]; mergedCells: string[][]; _headers: [ left?: string | any[] | CharType | undefined, center?: string | any[] | CharType | undefined, right?: string | any[] | CharType | undefined ]; _footers: [ left?: string | any[] | CharType | undefined, center?: string | any[] | CharType | undefined, right?: string | any[] | CharType | undefined ]; _tables: Table[]; _rowInstructions: any; _freezePane: { xSplit?: number; ySplit?: number; cell?: string; }; name: string; id: string; }; /** * Imports data - to be used while inside of a WorksheetExportWorker. * @param {Object} data */ importData(data: any): void; setSharedStringCollection(stringCollection: SharedStrings): void; addTable(table: Table): void; addDrawings(drawings: Drawings): void; setRowInstructions(rowIndex: number, instructions: ExcelStyleInstruction): void; /** * Expects an array length of three. * * @see Excel/Worksheet compilePageDetailPiece * @see <a href='/cookbook/addingHeadersAndFooters.html'>Adding headers and footers to a worksheet</a> * * @param {Array} headers [left, center, right] */ setHeader(headers: [ left: any, center: any, right: any ]): void; /** * Expects an array length of three. * * @see Excel/Worksheet compilePageDetailPiece * @see <a href='/cookbook/addingHeadersAndFooters.html'>Adding headers and footers to a worksheet</a> * * @param {Array} footers [left, center, right] */ setFooter(footers: [ left: any, center: any, right: any ]): void; /** * Turns page header/footer details into the proper format for Excel. * @param {type} data * @returns {String} */ compilePageDetailPackage(data: any): string; /** * Turns instructions on page header/footer details into something * usable by Excel. * * @param {type} data * @returns {String|@exp;_@call;reduce} */ compilePageDetailPiece(data: string | CharType | any[]): any; /** * Creates the header node. * * @todo implement the ability to do even/odd headers * @param {XML Doc} doc * @returns {XML Node} */ exportHeader(doc: XMLDOM): XMLNode; /** * Creates the footer node. * * @todo implement the ability to do even/odd footers * @param {XML Doc} doc * @returns {XML Node} */ exportFooter(doc: XMLDOM): XMLNode; /** * This creates some nodes ahead of time, which cuts down on generation time due to * most cell definitions being essentially the same, but having multiple nodes that need * to be created. Cloning takes less time than creation. * * @private * @param {XML Doc} doc * @returns {_L8.Anonym$0._buildCache.Anonym$2} */ _buildCache(doc: XMLDOM): { number: XMLNode; date: XMLNode; string: XMLNode; formula: XMLNode; }; /** * Runs through the XML document and grabs all of the strings that will * be sent to the 'shared strings' document. * * @returns {Array} */ collectSharedStrings(): string[]; toXML(): XMLDOM; /** * * @param {XML Doc} doc * @returns {XML Node} */ exportColumns(doc: XMLDOM): XMLNode; /** * Sets the page settings on a worksheet node. * * @param {XML Doc} doc * @param {XML Node} worksheet * @returns {undefined} */ exportPageSettings(doc: XMLDOM, worksheet: XMLNode): void; /** * http://www.schemacentral.com/sc/ooxml/t-ssml_ST_Orientation.html * * Can be one of 'portrait' or 'landscape'. * * @param {'default' | 'portrait' | 'landscape'} orientation * @returns {undefined} */ setPageOrientation(orientation: "default" | "portrait" | "landscape"): void; /** * Set page details in inches. * use this structure: * { * top: 0.7 * , bottom: 0.7 * , left: 0.7 * , right: 0.7 * , header: 0.3 * , footer: 0.3 * } * * @returns {undefined} */ setPageMargin(input: ExcelMargin): void; /** * Expects an array of column definitions. Each column definition needs to have a width assigned to it. * * @param {Array} columns */ setColumns(columns: ExcelColumn[]): void; /** * Expects an array of data to be translated into cells. * * @param {Array} data Two dimensional array - [ [A1, A2], [B1, B2] ] * @see <a href='/cookbook/addingDataToAWorksheet.html'>Adding data to a worksheet</a> */ setData(data: (number | string | boolean | Date | null | ExcelColumnMetadata)[][]): void; /** * Merge cells in given range * * @param cell1 - A1, A2... * @param cell2 - A2, A3... */ mergeCells(cell1: string, cell2: string): void; /** * Added frozen pane * @param column - column number: 0, 1, 2 ... * @param row - row number: 0, 1, 2 ... * @param cell - 'A1' * @deprecated */ freezePane(column: number, row: number, cell: string): void; /** * Expects an array containing an object full of column format definitions. * http://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.column.aspx * bestFit * collapsed * customWidth * hidden * max * min * outlineLevel * phonetic * style * width * @param {Array} columnFormats */ setColumnFormats(columnFormats: ExcelColumn[]): void; /** * Returns worksheet XML header (everything before <sheetData>) */ getWorksheetXmlHeader(): string; /** * Returns worksheet XML footer (everything after </sheetData>) */ getWorksheetXmlFooter(): string; /** * Serialize a chunk of rows to XML (same logic as in toXML) */ serializeRows(rows: (number | string | boolean | Date | null | ExcelColumnMetadata)[][], startRow?: number): string; } export interface MediaMeta { id: string; data: string; fileName: string; contentType: string | null; extension: string; rId?: string; } /** * @module Excel/Workbook */ export declare class Workbook { id: string; styleSheet: StyleSheet$1; sharedStrings: SharedStrings; relations: RelationshipManager; worksheets: Worksheet[]; charts: Chart[]; tables: Table[]; drawings: Drawings[]; media: { [filename: string]: MediaMeta; }; printTitles?: Record<string, { top?: number; left?: string; }>; constructor(); initialize(): void; createWorksheet(config?: any): Worksheet; getStyleSheet(): StyleSheet$1; addTable(table: Table): void; addDrawings(drawings: Drawings): void; addChart(chart: Chart): void; /** * Set number of rows to repeat for this sheet. * * @param {String} sheet name * @param {int} number of rows to repeat from the top * @returns {undefined} */ setPrintTitleTop(inSheet: string, inRowCount: number): void; /** * Set number of rows to repeat for this sheet. * * @param {String} sheet name * @param {int} number of columns to repeat from the left * @returns {undefined} */ setPrintTitleLeft(inSheet: string, inRowCount: number): void; addMedia(_type: string, fileName: string, fileData: any, contentType?: string | null): MediaMeta; addWorksheet(worksheet: Worksheet): void; createContentTypes(): XMLDOM; toXML(): XMLDOM; createWorkbookRelationship(): XMLDOM; _generateCorePaths(files: any): void; _prepareFilesForPackaging(files: { [path: string]: XMLDOM | string; }): void; generateFiles(): Promise<{ [path: string]: string; }>; /** Return workbook XML header */ serializeHeader(): string; /** Return workbook XML footer */ serializeFooter(): string; } export declare class Picture extends Drawing { id: string; pictureId: number; fill: any; mediaData: MediaMeta | null; description: string; constructor(); setMedia(mediaRef: MediaMeta): void; setDescription(description: string): void; setFillType(type: string): void; setFillConfig(config: any): void; getMediaType(): keyof typeof Util.schemas; getMediaData(): MediaMeta; setRelationshipId(rId: string): void; toXML(xmlDoc: XMLDOM): XMLNode; } /** * This is mostly a global spot where all of the relationship managers can get and set * path information from/to. * @module Excel/Paths */ export declare const Paths: { [path: string]: string; }; /** * Converts pixel sizes to 'EMU's, which is what Open XML uses. * * @todo clean this up. Code borrowed from http://polymathprogrammer.com/2009/10/22/english-metric-units-and-open-xml/, * but not sure that it's going to be as accurate as it needs to be. * * @param int pixels * @returns int */ export declare class Positioning { static pixelsToEMUs(pixels: number): number; } export type InferOutputByType<T extends "Blob" | "Uint8Array"> = T extends "Blob" ? Blob : T extends "Uint8Array" ? Uint8Array : any; /** * Creates a new workbook. */ export declare function createWorkbook(): Workbook; /** * Turns a Workbook into a downloadable file, you can switch output type a `Blob` or `Uint8Array`, * and if nothing is provided then `Blob` is the default output type. * @param {Excel/Workbook} workbook - The workbook that is being converted * @param {'Uint8Array' | 'Blob'} [outputType='Blob'] - defaults to 'Blob' * @param {Object} [options] * - `fileFormat` defaults to "xlsx" * - `mimeType`: a mime type can be provided by the user or auto-detect the mime when undefined (by file extension `.xls`/`.xlsx`) * (user can pass an empty string to completely cancel the mime type altogether) * - `zipOptions` to specify any `fflate` options to modify how the zip will be created. * @returns {Promise} */ export declare function createExcelFile<T extends "Blob" | "Uint8Array" = "Blob">(workbook: Workbook, outputType?: T, options?: { fileFormat?: "xls" | "xlsx"; mimeType?: string; zipOptions?: ZipOptions; }): Promise<InferOutputByType<T>>; /** * Download Excel file, currently only supports a "browser" as `downloadType` * but it could be expended in the future to also support other type of platforms like NodeJS for example. * @param {Workbook} workbook * @param {String} filename - filename (must also include file extension: `.xls` or `.xlsx`) * @param {Object} [options] * - `downloadType`: download type ('browser' / 'node'), currently only supports "browser" download as a Blob * - `mimeType`: a mime type can be provided by the user or auto-detect the mime when undefined (by file extension .xls/.xlsx) * (user can pass an empty string to completely cancel the mime type altogether) * - `zipOptions` to specify any `fflate` options to modify how the zip is created. */ export declare function downloadExcelFile(workbook: Workbook, filename: string, options?: { downloadType?: "browser" | "node"; mimeType?: string; zipOptions?: ZipOptions; }): Promise<void>; export interface ExcelFileStreamOptions { chunkSize?: number; outputType?: "Blob" | "Uint8Array" | "stream"; fileFormat?: "xlsx" | "xls"; mimeType?: string; zipOptions?: ZipOptions; downloadType?: "browser" | "node"; } /** * Environment-aware streaming Excel file generator. * Yields zipped chunks for browser (ReadableStream) or NodeJS (async generator). */ export declare function createExcelFileStream(workbook: Workbook, options?: ExcelFileStreamOptions): ReadableStream<Uint8Array<ArrayBufferLike>> | AsyncGenerator<Uint8Array<ArrayBufferLike>, void, unknown>; /** * Converts the characters "&", "<", ">", '"', and "'" in `string` to their * corresponding HTML entities. * * **Note:** No other characters are escaped. To escape additional * characters use a third-party library like [_he_](https://mths.be/he). * * Though the ">" character is escaped for symmetry, characters like * ">" and "/" don't need escaping in HTML and have no special meaning * unless they're part of a tag or unquoted attribute value. See * [Mathias Bynens's article](https://mathiasbynens.be/notes/ambiguous-ampersands) * (under "semi-related fun fact") for more details. * * When working with HTML you should always * [quote attribute values](http://wonko.com/post/html-escaping) to reduce * XSS vectors. * * @since 0.1.0 * @category String * @param {string} [str=''] The string to escape. * @returns {string} Returns the escaped string. * @see escapeRegExp, unescape * @example * * escape('fred, barney, & pebbles') * // => 'fred, barney, & pebbles' */ export declare const htmlEscape: (str: string) => string; export declare function isObject(value: unknown): value is object; export declare function isPlainObject(value: unknown): boolean; export declare function isString(value: any): value is string; export declare function pick(object: any, keys: string[]): any; /** * Generates a unique ID. If `prefix` is given, the ID is appended to it. * * @since 0.1.0 * @category Util * @param {string} [prefix=''] The value to prefix the ID with. * @returns {string} Returns the unique ID. * @see random * @example * * uniqueId('contact_') * // => 'contact_104' * * uniqueId() * // => '105' */ export declare function uniqueId(prefix?: string): string; export { StyleSheet$1 as StyleSheet, }; export {};