API Reference
Auto-generated API documentation
Functions
- api/aoa - addArrayToSheet, arrayToSheet, sheetToArray
- api/book - addCellComment, appendSheet, createSheet, createWorkbook, freezePanes, getSheetIndex, mergeCells, setArrayFormula, setCellHyperlink, setCellInternalLink, setCellNumberFormat, setCellStyle, setColumnWidth, setRowHeight, setSheetVisibility, sheetToFormulae, styleRange
- api/csv - csvToSheet, sheetToCsv, sheetToTxt
- api/format - formatCell
- api/html - htmlToSheet, sheetToHtml
- api/json - addJsonToSheet, jsonToSheet, sheetToJson
- read - read
- ssf/format - formatNumber
- utils/cell - decodeCell, decodeCol, decodeRange, decodeRow, encodeCell, encodeCol, encodeRange, encodeRow
- write - write
Type Aliases
- errors - XlsxErrorCode
- types - CellBorderStyle, DenseSheetData, ExcelDataType, NumberFormat, ReadResult, Sheet2FormulaeOpts, WriteResult
Interfaces
- AOA2SheetOpts - Options for creating a worksheet from a 2D array (Array of Arrays)
- AutoFilterInfo - AutoFilter definition for a worksheet
- BookPropsResult - Result returned when read() is called with bookProps enabled.
- BookSheetsAndPropsResult - Result returned when read() requests both sheet names and properties.
- BookSheetsResult - Result returned when read() is called with bookSheets enabled.
- CellAddress - Zero-based cell address with column (c) and row (r) indices
- CellAlignment - Cell alignment properties
- CellBorder - Border style properties for a cell
- CellBorderSide - Border side descriptor
- CellFill - Fill style properties for a cell
- CellFont - Font style properties for a cell
- CellObject - Worksheet Cell Object containing value, format, formula, and metadata
- CellStyle - Serializable XLSX cell style
- ColInfo - Column properties for worksheet column metadata
- Comment - A single comment entry within a cell's comment thread
- Comments - Array of comments attached to a cell, with optional visibility flag
- CSV2SheetOpts - Options for parsing CSV text into a worksheet.
- DefinedName - Defined Name (named range or named formula)
- FullProperties - Extended file properties (combines Core Properties with App-specific metadata)
- HTML2SheetOpts - Options for parsing an HTML table into a worksheet.
- Hyperlink - Hyperlink target and optional tooltip
- JSON2SheetOpts - Options for creating a worksheet from an array of JSON objects
- MarginInfo - Page margin settings in inches
- Properties - Basic file properties from the OPC Core Properties part
- ProtectInfo - Sheet protection settings controlling what users can do on a protected sheet
- Range - Range defined by start (s) and end (e) cell addresses
- ReadOptions - Options for reading/parsing workbook files
- RowInfo - Row properties for worksheet row metadata
- Sheet - Base sheet object supporting both sparse and dense storage modes.
- Sheet2CSVOpts - Options for converting a worksheet to CSV
- Sheet2HTMLOpts - Options for converting a worksheet to an HTML table string
- Sheet2JSONOpts - Options for converting a worksheet to an array of JSON objects
- SheetProps - Properties of a single sheet within the workbook
- SheetView - Frozen pane / sheet view metadata
- StyleColor - RGB/ARGB color descriptor used in cell styles
- WBProps - Workbook-level attributes (sheets, names, views, properties)
- WBView - Workbook view settings
- WorkBook - Top-level Workbook object containing all sheets, properties, and metadata
- WorkbookProperties - Workbook-level calculation and date system properties
- WorkSheet - Worksheet object with column, row, merge, protection, and filter metadata
- WorksheetCellBudgetOptions - Cumulative worksheet work limit shared by import and export APIs.
- WriteOptions - Options for writing/serializing workbook files
Classes
- XlsxError - Error subclass thrown by xlsx-format for deterministic failure handling.