@sheetkit/node / SheetData
Class: SheetData
Defined in: packages/sheetkit/sheet-data.ts:110
Constructors
Constructor
new SheetData(
buffer):SheetData
Defined in: packages/sheetkit/sheet-data.ts:125
Parameters
buffer
Buffer<ArrayBufferLike> | null
Returns
SheetData
Accessors
colCount
Get Signature
get colCount():
number
Defined in: packages/sheetkit/sheet-data.ts:172
Returns
number
maxRow
Get Signature
get maxRow():
number
Defined in: packages/sheetkit/sheet-data.ts:182
Last absolute worksheet row represented by this buffer, or 0 when empty.
Returns
number
minCol
Get Signature
get minCol():
number
Defined in: packages/sheetkit/sheet-data.ts:210
1-based worksheet column represented by the first buffered column.
Returns
number
minRow
Get Signature
get minRow():
number
Defined in: packages/sheetkit/sheet-data.ts:177
First absolute worksheet row represented by this buffer, or 0 when empty.
Returns
number
rowCount
Get Signature
get rowCount():
number
Defined in: packages/sheetkit/sheet-data.ts:168
Number of occupied row-index entries represented by this buffer.
Returns
number
rowSpan
Get Signature
get rowSpan():
number
Defined in: packages/sheetkit/sheet-data.ts:187
Inclusive distance between the first and last represented rows.
Returns
number
Methods
columnName()
columnName(
colIndex):string
Defined in: packages/sheetkit/sheet-data.ts:650
Parameters
colIndex
number
Returns
string
getCell()
getCell(
row,col):SheetDataCellValue
Defined in: packages/sheetkit/sheet-data.ts:330
Parameters
row
number
col
number
Returns
getCellType()
getCellType(
row,col):CellTypeName
Defined in: packages/sheetkit/sheet-data.ts:398
Parameters
row
number
col
number
Returns
getRow()
getRow(
rowNum):SheetDataCellValue[]
Defined in: packages/sheetkit/sheet-data.ts:460
Parameters
rowNum
number
Returns
occupiedRows()
occupiedRows():
Generator<OccupiedRow>
Defined in: packages/sheetkit/sheet-data.ts:631
Iterate occupied rows without allocating arrays for coordinate gaps.
Returns
Generator<OccupiedRow>
rows()
rows():
Generator<{row:number;values:SheetDataCellValue[]; }>
Defined in: packages/sheetkit/sheet-data.ts:619
Returns
Generator<{ row: number; values: SheetDataCellValue[]; }>
toArray()
toArray():
SheetDataCellValue[][]
Defined in: packages/sheetkit/sheet-data.ts:604
Returns
typedOccupiedRows()
typedOccupiedRows():
Generator<TypedOccupiedRow>
Defined in: packages/sheetkit/sheet-data.ts:641
Iterate occupied rows with cell types without repeating coordinate lookups.
Returns
Generator<TypedOccupiedRow>