---
url: /typescript-api/classes/SheetData.md
---
[@sheetkit/node](../globals.md) / SheetData

# Class: SheetData

Defined in: [packages/sheetkit/sheet-data.ts:110](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L110)

## Constructors

### Constructor

> **new SheetData**(`buffer`): `SheetData`

Defined in: [packages/sheetkit/sheet-data.ts:125](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L125)

#### Parameters

##### buffer

`Buffer`<`ArrayBufferLike`> | `null`

#### Returns

`SheetData`

## Accessors

### colCount

#### Get Signature

> **get** **colCount**(): `number`

Defined in: [packages/sheetkit/sheet-data.ts:172](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L172)

##### Returns

`number`

***

### maxRow

#### Get Signature

> **get** **maxRow**(): `number`

Defined in: [packages/sheetkit/sheet-data.ts:182](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L182)

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](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L210)

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](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L177)

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](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L168)

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](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L187)

Inclusive distance between the first and last represented rows.

##### Returns

`number`

## Methods

### columnName()

> **columnName**(`colIndex`): `string`

Defined in: [packages/sheetkit/sheet-data.ts:650](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L650)

#### Parameters

##### colIndex

`number`

#### Returns

`string`

***

### getCell()

> **getCell**(`row`, `col`): [`SheetDataCellValue`](../type-aliases/SheetDataCellValue.md)

Defined in: [packages/sheetkit/sheet-data.ts:330](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L330)

#### Parameters

##### row

`number`

##### col

`number`

#### Returns

[`SheetDataCellValue`](../type-aliases/SheetDataCellValue.md)

***

### getCellType()

> **getCellType**(`row`, `col`): [`CellTypeName`](../type-aliases/CellTypeName.md)

Defined in: [packages/sheetkit/sheet-data.ts:398](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L398)

#### Parameters

##### row

`number`

##### col

`number`

#### Returns

[`CellTypeName`](../type-aliases/CellTypeName.md)

***

### getRow()

> **getRow**(`rowNum`): [`SheetDataCellValue`](../type-aliases/SheetDataCellValue.md)\[]

Defined in: [packages/sheetkit/sheet-data.ts:460](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L460)

#### Parameters

##### rowNum

`number`

#### Returns

[`SheetDataCellValue`](../type-aliases/SheetDataCellValue.md)\[]

***

### occupiedRows()

> **occupiedRows**(): `Generator`<[`OccupiedRow`](../interfaces/OccupiedRow.md)>

Defined in: [packages/sheetkit/sheet-data.ts:631](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L631)

Iterate occupied rows without allocating arrays for coordinate gaps.

#### Returns

`Generator`<[`OccupiedRow`](../interfaces/OccupiedRow.md)>

***

### rows()

> **rows**(): `Generator`<{ `row`: `number`; `values`: [`SheetDataCellValue`](../type-aliases/SheetDataCellValue.md)\[]; }>

Defined in: [packages/sheetkit/sheet-data.ts:619](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L619)

#### Returns

`Generator`<{ `row`: `number`; `values`: [`SheetDataCellValue`](../type-aliases/SheetDataCellValue.md)\[]; }>

***

### toArray()

> **toArray**(): [`SheetDataCellValue`](../type-aliases/SheetDataCellValue.md)\[]\[]

Defined in: [packages/sheetkit/sheet-data.ts:604](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L604)

#### Returns

[`SheetDataCellValue`](../type-aliases/SheetDataCellValue.md)\[]\[]

***

### typedOccupiedRows()

> **typedOccupiedRows**(): `Generator`<[`TypedOccupiedRow`](../interfaces/TypedOccupiedRow.md)>

Defined in: [packages/sheetkit/sheet-data.ts:641](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/sheet-data.ts#L641)

Iterate occupied rows with cell types without repeating coordinate lookups.

#### Returns

`Generator`<[`TypedOccupiedRow`](../interfaces/TypedOccupiedRow.md)>
