Skip to content
Spreadsheet Engine

AreaArray

type AreaArray<T> = (T | null)[][] & AreaArrayAttributes<T>;

Array of arrays of Cell objects or their values, with some bounds attributes, sheet name and workbook name. Intended to represent the contents of a specified area of a sheet in a workbook.

  • top, left, bottom, right (non-negative integers) are the inclusive zero-based bounds of the area that this represents.
  • The nested array holds only the densely-populated part: its length is dataBottom - top + 1 and each row is dataRight - left + 1 wide. These equal bottom - top + 1 and right - left + 1 only when nothing was cropped or compacted away; otherwise the region between the populated data and bottom/right is described compactly by defaultRow, defaultColumn and defaultValue.
  • sheetName - name identifying a sheet in a workbook (possibly differing in case from the actual sheet name)
  • workbookName - name identifying a workbook (possibly differing in case from the actual workbook name)

T extends | Cell | CellValue | MaybeBoxed<CellValue> | ArrayValue | MaybeBoxed<ArrayValue>