api/aoa Functions
Functions from src/api/aoa.ts
Functions exported from src/api/aoa.ts
addArrayToSheet
function addArrayToSheet(worksheet: WorkSheet | null, data: any[][], opts?: AOA2SheetOpts): WorkSheetParameters
| Name | Type | Description |
|---|---|---|
| worksheet | `WorkSheet | null` |
| data | any[][] | The array-of-arrays containing raw cell values |
| opts (optional) | AOA2SheetOpts | Optional settings (origin, dense, dateNF, cellDates, UTC, date1904, nullError, sheetStubs) |
Returns
WorkSheet
The updated or newly created worksheet
arrayToSheet
function arrayToSheet(data: any[][], opts?: AOA2SheetOpts): WorkSheetParameters
| Name | Type | Description |
|---|---|---|
| data | any[][] | The array-of-arrays containing raw cell values |
| opts (optional) | AOA2SheetOpts | Optional settings (same as addArrayToSheet) |
Returns
WorkSheet
A new worksheet populated with the given data
sheetToArray
function sheetToArray<T>(sheet: WorkSheet, opts?: Omit<Sheet2JSONOpts, "header">): T[][]Parameters
| Name | Type | Description |
|---|---|---|
| sheet | WorkSheet | The worksheet to convert |
| opts (optional) | Omit<Sheet2JSONOpts, "header"> | Optional conversion settings, except header which is fixed to array output |
Returns
T[][]
A two-dimensional array of worksheet values