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

# Class: Workbook

Defined in: [packages/sheetkit/index.ts:1641](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1641)

Excel workbook for reading and writing .xlsx files.

## Constructors

### Constructor

> **new Workbook**(): `Workbook`

Defined in: [packages/sheetkit/index.ts:1644](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1644)

#### Returns

`Workbook`

## Accessors

### sheetNames

#### Get Signature

> **get** **sheetNames**(): `string`\[]

Defined in: [packages/sheetkit/index.ts:1732](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1732)

Get the names of all sheets in workbook order.

##### Returns

`string`\[]

## Methods

### addChart()

> **addChart**(`sheet`, `fromCell`, `toCell`, `config`): `void`

Defined in: [packages/sheetkit/index.ts:1987](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1987)

Add a chart to a sheet.

#### Parameters

##### sheet

`string`

##### fromCell

`string`

##### toCell

`string`

##### config

[`JsChartConfig`](../interfaces/JsChartConfig.md)

#### Returns

`void`

***

### addComment()

> **addComment**(`sheet`, `config`): `void`

Defined in: [packages/sheetkit/index.ts:2082](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2082)

Add a comment to a cell.

#### Parameters

##### sheet

`string`

##### config

[`JsCommentConfig`](../interfaces/JsCommentConfig.md)

#### Returns

`void`

***

### addDataValidation()

> **addDataValidation**(`sheet`, `config`): `void`

Defined in: [packages/sheetkit/index.ts:2052](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2052)

Add a data validation rule to a sheet.

#### Parameters

##### sheet

`string`

##### config

[`JsDataValidationConfig`](../interfaces/JsDataValidationConfig.md)

#### Returns

`void`

***

### addFormControl()

> **addFormControl**(`sheet`, `config`): `void`

Defined in: [packages/sheetkit/index.ts:2022](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2022)

Add a form control to a sheet.

#### Parameters

##### sheet

`string`

##### config

[`JsFormControlConfig`](../interfaces/JsFormControlConfig.md)

#### Returns

`void`

***

### addImage()

> **addImage**(`sheet`, `config`): `void`

Defined in: [packages/sheetkit/index.ts:1992](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1992)

Add an image to a sheet.

#### Parameters

##### sheet

`string`

##### config

[`JsImageConfig`](../interfaces/JsImageConfig.md)

#### Returns

`void`

***

### addPerson()

> **addPerson**(`input`): `string`

Defined in: [packages/sheetkit/index.ts:2122](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2122)

Add a person to the person list. Returns the person ID.

#### Parameters

##### input

[`JsPersonInput`](../interfaces/JsPersonInput.md)

#### Returns

`string`

***

### addPivotTable()

> **addPivotTable**(`config`, `options?`): `void`

Defined in: [packages/sheetkit/index.ts:2428](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2428)

Add a pivot table using finite dense source traversal limits.

#### Parameters

##### config

[`JsPivotTableConfig`](../interfaces/JsPivotTableConfig.md)

##### options?

[`TraversalOptions`](../interfaces/TraversalOptions.md)

#### Returns

`void`

***

### addShape()

> **addShape**(`sheet`, `config`): `void`

Defined in: [packages/sheetkit/index.ts:1997](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1997)

Add a shape to a sheet, anchored between two cells.

#### Parameters

##### sheet

`string`

##### config

[`JsShapeConfig`](../interfaces/JsShapeConfig.md)

#### Returns

`void`

***

### addSlicer()

> **addSlicer**(`sheet`, `config`): `void`

Defined in: [packages/sheetkit/index.ts:2473](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2473)

Add a slicer to a sheet targeting a table column.

#### Parameters

##### sheet

`string`

##### config

[`JsSlicerConfig`](../interfaces/JsSlicerConfig.md)

#### Returns

`void`

***

### addSparkline()

> **addSparkline**(`sheet`, `config`): `void`

Defined in: [packages/sheetkit/index.ts:2443](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2443)

Add a sparkline to a worksheet.

#### Parameters

##### sheet

`string`

##### config

[`JsSparklineConfig`](../interfaces/JsSparklineConfig.md)

#### Returns

`void`

***

### addStyle()

> **addStyle**(`style`): `number`

Defined in: [packages/sheetkit/index.ts:1952](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1952)

Add a style definition. Returns the style ID for use with setCellStyle.

#### Parameters

##### style

[`JsStyle`](../interfaces/JsStyle.md)

#### Returns

`number`

***

### addTable()

> **addTable**(`sheet`, `config`): `void`

Defined in: [packages/sheetkit/index.ts:2458](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2458)

Register a table in the workbook.

#### Parameters

##### sheet

`string`

##### config

[`JsTableConfig`](../interfaces/JsTableConfig.md)

#### Returns

`void`

***

### addThreadedComment()

> **addThreadedComment**(`sheet`, `cell`, `input`): `string`

Defined in: [packages/sheetkit/index.ts:2097](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2097)

Add a threaded comment to a cell. Returns the comment ID.

#### Parameters

##### sheet

`string`

##### cell

`string`

##### input

[`JsThreadedCommentInput`](../interfaces/JsThreadedCommentInput.md)

#### Returns

`string`

***

### applyStreamWriter()

> **applyStreamWriter**(`writer`): `number`

Defined in: [packages/sheetkit/index.ts:2147](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2147)

Apply a stream writer's output to the workbook. Returns the sheet index.

#### Parameters

##### writer

[`JsStreamWriter`](JsStreamWriter.md)

#### Returns

`number`

***

### calculateAll()

> **calculateAll**(`limits?`): `void`

Defined in: [packages/sheetkit/index.ts:2423](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2423)

Recalculate all formula cells in the workbook.

#### Parameters

##### limits?

[`FormulaLimits`](../interfaces/FormulaLimits.md)

#### Returns

`void`

***

### copySheet()

> **copySheet**(`source`, `target`): `number`

Defined in: [packages/sheetkit/index.ts:1847](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1847)

Copy a sheet. Returns the new sheet's 0-based index.

#### Parameters

##### source

`string`

##### target

`string`

#### Returns

`number`

***

### deleteCellHyperlink()

> **deleteCellHyperlink**(`sheet`, `cell`): `void`

Defined in: [packages/sheetkit/index.ts:2298](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2298)

Delete a hyperlink from a cell.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

`void`

***

### deleteChart()

> **deleteChart**(`sheet`, `cell`): `void`

Defined in: [packages/sheetkit/index.ts:2002](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2002)

Delete a chart anchored at the given cell.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

`void`

***

### deleteConditionalFormat()

> **deleteConditionalFormat**(`sheet`, `sqref`): `void`

Defined in: [packages/sheetkit/index.ts:2077](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2077)

Delete conditional formatting for a specific cell range.

#### Parameters

##### sheet

`string`

##### sqref

`string`

#### Returns

`void`

***

### deleteCustomProperty()

> **deleteCustomProperty**(`name`): `boolean`

Defined in: [packages/sheetkit/index.ts:2194](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2194)

Delete a custom property. Returns true if it existed.

#### Parameters

##### name

`string`

#### Returns

`boolean`

***

### deleteDefinedName()

> **deleteDefinedName**(`name`, `scope?`): `void`

Defined in: [packages/sheetkit/index.ts:2518](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2518)

Delete a defined name by name and optional scope.

#### Parameters

##### name

`string`

##### scope?

`string` | `null`

#### Returns

`void`

***

### deleteFormControl()

> **deleteFormControl**(`sheet`, `index`): `void`

Defined in: [packages/sheetkit/index.ts:2032](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2032)

Delete a form control by index.

#### Parameters

##### sheet

`string`

##### index

`number`

#### Returns

`void`

***

### deletePicture()

> **deletePicture**(`sheet`, `cell`): `void`

Defined in: [packages/sheetkit/index.ts:2007](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2007)

Delete a picture anchored at the given cell.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

`void`

***

### deletePivotTable()

> **deletePivotTable**(`name`): `void`

Defined in: [packages/sheetkit/index.ts:2438](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2438)

Delete a pivot table by name.

#### Parameters

##### name

`string`

#### Returns

`void`

***

### deleteSheet()

> **deleteSheet**(`name`): `void`

Defined in: [packages/sheetkit/index.ts:1837](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1837)

Delete a sheet by name.

#### Parameters

##### name

`string`

#### Returns

`void`

***

### deleteSlicer()

> **deleteSlicer**(`sheet`, `name`): `void`

Defined in: [packages/sheetkit/index.ts:2483](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2483)

Delete a slicer by name from a sheet.

#### Parameters

##### sheet

`string`

##### name

`string`

#### Returns

`void`

***

### deleteTable()

> **deleteTable**(`sheet`, `name`): `void`

Defined in: [packages/sheetkit/index.ts:2468](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2468)

Delete a table from a sheet by name.

#### Parameters

##### sheet

`string`

##### name

`string`

#### Returns

`void`

***

### deleteThreadedComment()

> **deleteThreadedComment**(`sheet`, `commentId`): `void`

Defined in: [packages/sheetkit/index.ts:2112](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2112)

Delete a threaded comment by ID.

#### Parameters

##### sheet

`string`

##### commentId

`string`

#### Returns

`void`

***

### duplicateRow()

> **duplicateRow**(`sheet`, `row`): `void`

Defined in: [packages/sheetkit/index.ts:1877](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1877)

Duplicate a row (1-based).

#### Parameters

##### sheet

`string`

##### row

`number`

#### Returns

`void`

***

### evaluateFormula()

> **evaluateFormula**(`sheet`, `formula`, `limits?`): [`CellValue`](../type-aliases/CellValue.md)

Defined in: [packages/sheetkit/index.ts:2415](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2415)

Evaluate a formula string against the current workbook data.

#### Parameters

##### sheet

`string`

##### formula

`string`

##### limits?

[`FormulaLimits`](../interfaces/FormulaLimits.md)

#### Returns

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

***

### fillFormula()

> **fillFormula**(`sheet`, `range`, `formula`, `limits?`): `void`

Defined in: [packages/sheetkit/index.ts:2410](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2410)

Fill a range with a formula using finite mutation limits.

#### Parameters

##### sheet

`string`

##### range

`string`

##### formula

`string`

##### limits?

[`FormulaLimits`](../interfaces/FormulaLimits.md)

#### Returns

`void`

***

### fromJSON()

> **fromJSON**(`sheet`, `data`, `options?`): `void`

Defined in: [packages/sheetkit/index.ts:2741](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2741)

Write an array of JSON objects to a sheet.

#### Parameters

##### sheet

`string`

##### data

`Record`<`string`, [`CellValue`](../type-aliases/CellValue.md)>\[]

##### options?

[`FromJsonOptions`](../interfaces/FromJsonOptions.md)

#### Returns

`void`

***

### getActiveSheet()

> **getActiveSheet**(): `string`

Defined in: [packages/sheetkit/index.ts:1857](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1857)

Get the name of the active sheet.

#### Returns

`string`

***

### getAppProps()

> **getAppProps**(): [`JsAppProperties`](../interfaces/JsAppProperties.md)

Defined in: [packages/sheetkit/index.ts:2179](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2179)

Get application properties.

#### Returns

[`JsAppProperties`](../interfaces/JsAppProperties.md)

***

### getCellFormattedValue()

> **getCellFormattedValue**(`sheet`, `cell`): `string`

Defined in: [packages/sheetkit/index.ts:1796](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1796)

Get the formatted display text for a cell, applying its number format.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

`string`

***

### getCellHyperlink()

> **getCellHyperlink**(`sheet`, `cell`): [`JsHyperlinkInfo`](../interfaces/JsHyperlinkInfo.md) | `null`

Defined in: [packages/sheetkit/index.ts:2293](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2293)

Get hyperlink information for a cell, or null if no hyperlink exists.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

[`JsHyperlinkInfo`](../interfaces/JsHyperlinkInfo.md) | `null`

***

### getCellRichText()

> **getCellRichText**(`sheet`, `cell`): [`JsRichTextRun`](../interfaces/JsRichTextRun.md)\[] | `null`

Defined in: [packages/sheetkit/index.ts:2493](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2493)

Get rich text runs for a cell, or null if not rich text.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

[`JsRichTextRun`](../interfaces/JsRichTextRun.md)\[] | `null`

***

### getCellStyle()

> **getCellStyle**(`sheet`, `cell`): `number` | `null`

Defined in: [packages/sheetkit/index.ts:1957](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1957)

Get the style ID applied to a cell, or null if default.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

`number` | `null`

***

### getCellValue()

> **getCellValue**(`sheet`, `cell`): [`CellValue`](../type-aliases/CellValue.md)

Defined in: [packages/sheetkit/index.ts:1785](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1785)

Get the value of a cell. A formula cell returns a FormulaValue with its cached result.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

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

***

### getColOutlineLevel()

> **getColOutlineLevel**(`sheet`, `col`): `number`

Defined in: [packages/sheetkit/index.ts:1937](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1937)

Get the outline level of a column. Returns 0 if not set.

#### Parameters

##### sheet

`string`

##### col

`string`

#### Returns

`number`

***

### getCols()

> **getCols**(`sheet`, `options?`): [`JsColData`](../interfaces/JsColData.md)\[]

Defined in: [packages/sheetkit/index.ts:2400](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2400)

Get all occupied columns using finite sparse traversal limits.

#### Parameters

##### sheet

`string`

##### options?

[`TraversalOptions`](../interfaces/TraversalOptions.md)

#### Returns

[`JsColData`](../interfaces/JsColData.md)\[]

***

### getColStyle()

> **getColStyle**(`sheet`, `col`): `number`

Defined in: [packages/sheetkit/index.ts:1982](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1982)

Get the style ID for a column. Returns 0 if not set.

#### Parameters

##### sheet

`string`

##### col

`string`

#### Returns

`number`

***

### getColVisible()

> **getColVisible**(`sheet`, `col`): `boolean`

Defined in: [packages/sheetkit/index.ts:1927](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1927)

Get whether a column is visible.

#### Parameters

##### sheet

`string`

##### col

`string`

#### Returns

`boolean`

***

### getColWidth()

> **getColWidth**(`sheet`, `col`): `number` | `null`

Defined in: [packages/sheetkit/index.ts:1917](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1917)

Get the width of a column, or null if not explicitly set.

#### Parameters

##### sheet

`string`

##### col

`string`

#### Returns

`number` | `null`

***

### getComments()

> **getComments**(`sheet`): [`JsCommentConfig`](../interfaces/JsCommentConfig.md)\[]

Defined in: [packages/sheetkit/index.ts:2087](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2087)

Get all comments on a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsCommentConfig`](../interfaces/JsCommentConfig.md)\[]

***

### getConditionalFormats()

> **getConditionalFormats**(`sheet`): [`JsConditionalFormatEntry`](../interfaces/JsConditionalFormatEntry.md)\[]

Defined in: [packages/sheetkit/index.ts:2072](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2072)

Get all conditional formatting rules for a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsConditionalFormatEntry`](../interfaces/JsConditionalFormatEntry.md)\[]

***

### getCustomProperty()

> **getCustomProperty**(`name`): `string` | `number` | `boolean` | `null`

Defined in: [packages/sheetkit/index.ts:2189](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2189)

Get a custom property value, or null if not found.

#### Parameters

##### name

`string`

#### Returns

`string` | `number` | `boolean` | `null`

***

### getDataValidations()

> **getDataValidations**(`sheet`): [`JsDataValidationConfig`](../interfaces/JsDataValidationConfig.md)\[]

Defined in: [packages/sheetkit/index.ts:2057](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2057)

Get all data validations on a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsDataValidationConfig`](../interfaces/JsDataValidationConfig.md)\[]

***

### getDefinedName()

> **getDefinedName**(`name`, `scope?`): [`JsDefinedNameInfo`](../interfaces/JsDefinedNameInfo.md) | `null`

Defined in: [packages/sheetkit/index.ts:2508](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2508)

Get a defined name by name and optional scope.

#### Parameters

##### name

`string`

##### scope?

`string` | `null`

#### Returns

[`JsDefinedNameInfo`](../interfaces/JsDefinedNameInfo.md) | `null`

***

### getDefinedNames()

> **getDefinedNames**(): [`JsDefinedNameInfo`](../interfaces/JsDefinedNameInfo.md)\[]

Defined in: [packages/sheetkit/index.ts:2513](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2513)

Get all defined names in the workbook.

#### Returns

[`JsDefinedNameInfo`](../interfaces/JsDefinedNameInfo.md)\[]

***

### getDocProps()

> **getDocProps**(): [`JsDocProperties`](../interfaces/JsDocProperties.md)

Defined in: [packages/sheetkit/index.ts:2169](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2169)

Get core document properties.

#### Returns

[`JsDocProperties`](../interfaces/JsDocProperties.md)

***

### getFormat()

> **getFormat**(): `string`

Defined in: [packages/sheetkit/index.ts:2889](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2889)

Get the workbook format ("xlsx", "xlsm", "xltx", "xltm", "xlam").

#### Returns

`string`

***

### getFormControls()

> **getFormControls**(`sheet`): [`JsFormControlInfo`](../interfaces/JsFormControlInfo.md)\[]

Defined in: [packages/sheetkit/index.ts:2027](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2027)

Get all form controls on a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsFormControlInfo`](../interfaces/JsFormControlInfo.md)\[]

***

### getHeaderFooter()

> **getHeaderFooter**(`sheet`): [`JsHeaderFooter`](../interfaces/JsHeaderFooter.md)

Defined in: [packages/sheetkit/index.ts:2258](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2258)

Get the header and footer text for a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsHeaderFooter`](../interfaces/JsHeaderFooter.md)

***

### getMergeCells()

> **getMergeCells**(`sheet`): `string`\[]

Defined in: [packages/sheetkit/index.ts:2047](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2047)

Get all merged cell ranges on a sheet.

#### Parameters

##### sheet

`string`

#### Returns

`string`\[]

***

### getPageBreaks()

> **getPageBreaks**(`sheet`): `number`\[]

Defined in: [packages/sheetkit/index.ts:2283](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2283)

Get all row page break positions (1-based row numbers).

#### Parameters

##### sheet

`string`

#### Returns

`number`\[]

***

### getPageMargins()

> **getPageMargins**(`sheet`): [`JsPageMargins`](../interfaces/JsPageMargins.md)

Defined in: [packages/sheetkit/index.ts:2234](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2234)

Get page margins for a sheet. Returns defaults if not explicitly set.

#### Parameters

##### sheet

`string`

#### Returns

[`JsPageMargins`](../interfaces/JsPageMargins.md)

***

### getPageSetup()

> **getPageSetup**(`sheet`): [`JsPageSetup`](../interfaces/JsPageSetup.md)

Defined in: [packages/sheetkit/index.ts:2244](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2244)

Get the page setup for a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsPageSetup`](../interfaces/JsPageSetup.md)

***

### getPanes()

> **getPanes**(`sheet`): `string` | `null`

Defined in: [packages/sheetkit/index.ts:2224](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2224)

Get the current freeze pane cell reference for a sheet, or null if none.

#### Parameters

##### sheet

`string`

#### Returns

`string` | `null`

***

### getPersons()

> **getPersons**(): [`JsPersonData`](../interfaces/JsPersonData.md)\[]

Defined in: [packages/sheetkit/index.ts:2127](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2127)

Get all persons in the person list.

#### Returns

[`JsPersonData`](../interfaces/JsPersonData.md)\[]

***

### getPictureCells()

> **getPictureCells**(`sheet`): `string`\[]

Defined in: [packages/sheetkit/index.ts:2017](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2017)

Get all cells that have pictures anchored to them on the given sheet.

#### Parameters

##### sheet

`string`

#### Returns

`string`\[]

***

### getPictures()

> **getPictures**(`sheet`, `cell`): [`JsPictureInfo`](../interfaces/JsPictureInfo.md)\[]

Defined in: [packages/sheetkit/index.ts:2012](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2012)

Get all pictures anchored at the given cell.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

[`JsPictureInfo`](../interfaces/JsPictureInfo.md)\[]

***

### getPivotTables()

> **getPivotTables**(): [`JsPivotTableInfo`](../interfaces/JsPivotTableInfo.md)\[]

Defined in: [packages/sheetkit/index.ts:2433](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2433)

Get all pivot tables in the workbook.

#### Returns

[`JsPivotTableInfo`](../interfaces/JsPivotTableInfo.md)\[]

***

### getPrintOptions()

> **getPrintOptions**(`sheet`): [`JsPrintOptions`](../interfaces/JsPrintOptions.md)

Defined in: [packages/sheetkit/index.ts:2268](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2268)

Get print options for a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsPrintOptions`](../interfaces/JsPrintOptions.md)

***

### getRowHeight()

> **getRowHeight**(`sheet`, `row`): `number` | `null`

Defined in: [packages/sheetkit/index.ts:1887](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1887)

Get the height of a row, or null if not explicitly set.

#### Parameters

##### sheet

`string`

##### row

`number`

#### Returns

`number` | `null`

***

### getRowOutlineLevel()

> **getRowOutlineLevel**(`sheet`, `row`): `number`

Defined in: [packages/sheetkit/index.ts:1907](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1907)

Get the outline level of a row. Returns 0 if not set.

#### Parameters

##### sheet

`string`

##### row

`number`

#### Returns

`number`

***

### getRows()

> **getRows**(`sheet`, `options?`): [`JsRowData`](../interfaces/JsRowData.md)\[]

Defined in: [packages/sheetkit/index.ts:2337](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2337)

Get all rows with their data from a sheet using buffer-based transfer.
Formula cells carry `formula` with the expression and cached result.

#### Parameters

##### sheet

`string`

##### options?

[`TraversalOptions`](../interfaces/TraversalOptions.md)

#### Returns

[`JsRowData`](../interfaces/JsRowData.md)\[]

***

### getRowsBuffer()

> **getRowsBuffer**(`sheet`, `options?`): `Buffer`

Defined in: [packages/sheetkit/index.ts:2351](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2351)

Serialize a sheet's cell data into a compact binary buffer (v1 format).

#### Parameters

##### sheet

`string`

##### options?

[`TraversalOptions`](../interfaces/TraversalOptions.md)

#### Returns

`Buffer`

***

### getRowsBufferV2()

> **getRowsBufferV2**(`sheet`, `options?`): `Buffer`

Defined in: [packages/sheetkit/index.ts:2360](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2360)

Serialize a sheet's cell data into a v2 binary buffer with inline strings.
The v2 format eliminates the global string table, enabling incremental
row-by-row decoding without eagerly materializing all strings.

#### Parameters

##### sheet

`string`

##### options?

[`TraversalOptions`](../interfaces/TraversalOptions.md)

#### Returns

`Buffer`

***

### getRowsIterator()

> **getRowsIterator**(`sheet`, `options?`): `Generator`<[`JsRowData`](../interfaces/JsRowData.md)>

Defined in: [packages/sheetkit/index.ts:2381](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2381)

Get a generator that yields one row at a time from the sheet, avoiding
materializing the entire result array in memory at once.
Formula cells carry `formula` with the expression and cached result.

#### Parameters

##### sheet

`string`

##### options?

[`TraversalOptions`](../interfaces/TraversalOptions.md)

#### Returns

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

***

### getRowsRaw()

> **getRowsRaw**(`sheet`, `options?`): [`RawRowsResult`](../interfaces/RawRowsResult.md)

Defined in: [packages/sheetkit/index.ts:2370](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2370)

Get all rows as typed arrays with minimal JS object creation.
Returns column numbers (not names), cell types, and values in parallel
typed arrays. Use this when processing large sheets where object creation
overhead matters.

#### Parameters

##### sheet

`string`

##### options?

[`TraversalOptions`](../interfaces/TraversalOptions.md)

#### Returns

[`RawRowsResult`](../interfaces/RawRowsResult.md)

***

### getRowStyle()

> **getRowStyle**(`sheet`, `row`): `number`

Defined in: [packages/sheetkit/index.ts:1972](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1972)

Get the style ID for a row. Returns 0 if not set.

#### Parameters

##### sheet

`string`

##### row

`number`

#### Returns

`number`

***

### getRowVisible()

> **getRowVisible**(`sheet`, `row`): `boolean`

Defined in: [packages/sheetkit/index.ts:1897](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1897)

Get whether a row is visible.

#### Parameters

##### sheet

`string`

##### row

`number`

#### Returns

`boolean`

***

### getSheetIndex()

> **getSheetIndex**(`name`): `number` | `null`

Defined in: [packages/sheetkit/index.ts:1852](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1852)

Get the 0-based index of a sheet, or null if not found.

#### Parameters

##### name

`string`

#### Returns

`number` | `null`

***

### getSheetViewOptions()

> **getSheetViewOptions**(`sheet`): [`JsSheetViewOptions`](../interfaces/JsSheetViewOptions.md)

Defined in: [packages/sheetkit/index.ts:2899](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2899)

Get sheet view options.

#### Parameters

##### sheet

`string`

#### Returns

[`JsSheetViewOptions`](../interfaces/JsSheetViewOptions.md)

***

### getSheetVisibility()

> **getSheetVisibility**(`sheet`): `string`

Defined in: [packages/sheetkit/index.ts:2909](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2909)

Get sheet visibility. Returns "visible", "hidden", or "veryHidden".

#### Parameters

##### sheet

`string`

#### Returns

`string`

***

### getSlicers()

> **getSlicers**(`sheet`): [`JsSlicerInfo`](../interfaces/JsSlicerInfo.md)\[]

Defined in: [packages/sheetkit/index.ts:2478](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2478)

Get all slicers on a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsSlicerInfo`](../interfaces/JsSlicerInfo.md)\[]

***

### getSparklines()

> **getSparklines**(`sheet`): [`JsSparklineConfig`](../interfaces/JsSparklineConfig.md)\[]

Defined in: [packages/sheetkit/index.ts:2448](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2448)

Get all sparklines for a worksheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsSparklineConfig`](../interfaces/JsSparklineConfig.md)\[]

***

### getTables()

> **getTables**(`sheet`): [`JsTableInfo`](../interfaces/JsTableInfo.md)\[]

Defined in: [packages/sheetkit/index.ts:2463](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2463)

Get all tables on a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsTableInfo`](../interfaces/JsTableInfo.md)\[]

***

### getThemeColor()

> **getThemeColor**(`index`, `tint?`): `string` | `null`

Defined in: [packages/sheetkit/index.ts:2498](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2498)

Resolve a theme color by index (0-11) with optional tint.

#### Parameters

##### index

`number`

##### tint?

`number` | `null`

#### Returns

`string` | `null`

***

### getThreadedComments()

> **getThreadedComments**(`sheet`): [`JsThreadedCommentData`](../interfaces/JsThreadedCommentData.md)\[]

Defined in: [packages/sheetkit/index.ts:2102](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2102)

Get all threaded comments on a sheet.

#### Parameters

##### sheet

`string`

#### Returns

[`JsThreadedCommentData`](../interfaces/JsThreadedCommentData.md)\[]

***

### getThreadedCommentsByCell()

> **getThreadedCommentsByCell**(`sheet`, `cell`): [`JsThreadedCommentData`](../interfaces/JsThreadedCommentData.md)\[]

Defined in: [packages/sheetkit/index.ts:2107](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2107)

Get threaded comments for a specific cell on a sheet.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

[`JsThreadedCommentData`](../interfaces/JsThreadedCommentData.md)\[]

***

### getVbaModules()

> **getVbaModules**(`limits?`): [`JsVbaProject`](../interfaces/JsVbaProject.md) | `null`

Defined in: [packages/sheetkit/index.ts:2924](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2924)

Extract VBA module source code from the workbook's VBA project. Returns null if no VBA project.

#### Parameters

##### limits?

[`VbaLimits`](../interfaces/VbaLimits.md) | [`JsVbaLimits`](../interfaces/JsVbaLimits.md)

#### Returns

[`JsVbaProject`](../interfaces/JsVbaProject.md) | `null`

***

### getVbaProject()

> **getVbaProject**(): `Buffer`<`ArrayBufferLike`> | `null`

Defined in: [packages/sheetkit/index.ts:2919](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2919)

Get the raw VBA project binary (xl/vbaProject.bin), or null if not present.

#### Returns

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

***

### insertCols()

> **insertCols**(`sheet`, `col`, `count`): `void`

Defined in: [packages/sheetkit/index.ts:1942](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1942)

Insert empty columns starting at the given column letter.

#### Parameters

##### sheet

`string`

##### col

`string`

##### count

`number`

#### Returns

`void`

***

### insertPageBreak()

> **insertPageBreak**(`sheet`, `row`): `void`

Defined in: [packages/sheetkit/index.ts:2273](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2273)

Insert a horizontal page break before the given 1-based row.

#### Parameters

##### sheet

`string`

##### row

`number`

#### Returns

`void`

***

### insertRows()

> **insertRows**(`sheet`, `startRow`, `count`): `void`

Defined in: [packages/sheetkit/index.ts:1867](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1867)

Insert empty rows starting at the given 1-based row number.

#### Parameters

##### sheet

`string`

##### startRow

`number`

##### count

`number`

#### Returns

`void`

***

### isSheetProtected()

> **isSheetProtected**(`sheet`): `boolean`

Defined in: [packages/sheetkit/index.ts:2533](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2533)

Check if a sheet is protected.

#### Parameters

##### sheet

`string`

#### Returns

`boolean`

***

### isWorkbookProtected()

> **isWorkbookProtected**(): `boolean`

Defined in: [packages/sheetkit/index.ts:2209](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2209)

Check if the workbook is protected.

#### Returns

`boolean`

***

### mergeCells()

> **mergeCells**(`sheet`, `topLeft`, `bottomRight`): `void`

Defined in: [packages/sheetkit/index.ts:2037](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2037)

Merge a range of cells on a sheet.

#### Parameters

##### sheet

`string`

##### topLeft

`string`

##### bottomRight

`string`

#### Returns

`void`

***

### newSheet()

> **newSheet**(`name`): `number`

Defined in: [packages/sheetkit/index.ts:1832](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1832)

Create a new empty sheet. Returns the 0-based sheet index.

#### Parameters

##### name

`string`

#### Returns

`number`

***

### newStreamWriter()

> **newStreamWriter**(`sheetName`, `limits?`): [`JsStreamWriter`](JsStreamWriter.md)

Defined in: [packages/sheetkit/index.ts:2142](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2142)

Create a new stream writer for a new sheet.

#### Parameters

##### sheetName

`string`

##### limits?

[`StreamLimits`](../interfaces/StreamLimits.md) | [`JsStreamLimits`](../interfaces/JsStreamLimits.md)

#### Returns

[`JsStreamWriter`](JsStreamWriter.md)

***

### openSheetReader()

> **openSheetReader**(`sheet`, `opts?`): `Promise`<[`SheetStreamReader`](SheetStreamReader.md)>

Defined in: [packages/sheetkit/index.ts:2156](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2156)

Open a forward-only streaming reader for the named sheet.
Reads rows from a bounded incremental source without loading the entire
worksheet into memory.

#### Parameters

##### sheet

`string`

##### opts?

###### batchSize?

`number`

#### Returns

`Promise`<[`SheetStreamReader`](SheetStreamReader.md)>

***

### protectSheet()

> **protectSheet**(`sheet`, `config?`): `void`

Defined in: [packages/sheetkit/index.ts:2523](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2523)

Protect a sheet with optional password and permission settings.

#### Parameters

##### sheet

`string`

##### config?

[`JsSheetProtectionConfig`](../interfaces/JsSheetProtectionConfig.md) | `null`

#### Returns

`void`

***

### protectWorkbook()

> **protectWorkbook**(`config`): `void`

Defined in: [packages/sheetkit/index.ts:2199](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2199)

Protect the workbook structure/windows with optional password.

#### Parameters

##### config

[`JsWorkbookProtectionConfig`](../interfaces/JsWorkbookProtectionConfig.md)

#### Returns

`void`

***

### removeAutoFilter()

> **removeAutoFilter**(`sheet`): `void`

Defined in: [packages/sheetkit/index.ts:2137](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2137)

Remove the auto-filter from a sheet.

#### Parameters

##### sheet

`string`

#### Returns

`void`

***

### removeCol()

> **removeCol**(`sheet`, `col`): `void`

Defined in: [packages/sheetkit/index.ts:1947](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1947)

Remove a column by letter.

#### Parameters

##### sheet

`string`

##### col

`string`

#### Returns

`void`

***

### removeComment()

> **removeComment**(`sheet`, `cell`): `void`

Defined in: [packages/sheetkit/index.ts:2092](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2092)

Remove a comment from a cell.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

`void`

***

### removeDataValidation()

> **removeDataValidation**(`sheet`, `sqref`): `void`

Defined in: [packages/sheetkit/index.ts:2062](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2062)

Remove a data validation by sqref.

#### Parameters

##### sheet

`string`

##### sqref

`string`

#### Returns

`void`

***

### removePageBreak()

> **removePageBreak**(`sheet`, `row`): `void`

Defined in: [packages/sheetkit/index.ts:2278](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2278)

Remove a horizontal page break at the given 1-based row.

#### Parameters

##### sheet

`string`

##### row

`number`

#### Returns

`void`

***

### removeRow()

> **removeRow**(`sheet`, `row`): `void`

Defined in: [packages/sheetkit/index.ts:1872](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1872)

Remove a row (1-based).

#### Parameters

##### sheet

`string`

##### row

`number`

#### Returns

`void`

***

### removeSparkline()

> **removeSparkline**(`sheet`, `location`): `void`

Defined in: [packages/sheetkit/index.ts:2453](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2453)

Remove a sparkline by its location cell reference.

#### Parameters

##### sheet

`string`

##### location

`string`

#### Returns

`void`

***

### renderToSvg()

> **renderToSvg**(`options`, `traversal?`): `string`

Defined in: [packages/sheetkit/index.ts:2914](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2914)

Render a worksheet to SVG using finite dense traversal limits.

#### Parameters

##### options

[`JsRenderOptions`](../interfaces/JsRenderOptions.md)

##### traversal?

[`TraversalOptions`](../interfaces/TraversalOptions.md)

#### Returns

`string`

***

### resolveThreadedComment()

> **resolveThreadedComment**(`sheet`, `commentId`, `done`): `void`

Defined in: [packages/sheetkit/index.ts:2117](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2117)

Set the resolved (done) state of a threaded comment.

#### Parameters

##### sheet

`string`

##### commentId

`string`

##### done

`boolean`

#### Returns

`void`

***

### save()

> **save**(`path`, `limits?`, `options?`): `Promise`<`void`>

Defined in: [packages/sheetkit/index.ts:1746](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1746)

Save the workbook using destination-preserving atomic replacement. See [SaveOptions](../interfaces/SaveOptions.md).

#### Parameters

##### path

`string`

##### limits?

[`SaveLimits`](../interfaces/SaveLimits.md) | [`JsSaveLimits`](../interfaces/JsSaveLimits.md)

##### options?

[`SaveOptions`](../interfaces/SaveOptions.md) | [`JsSaveOptions`](../interfaces/JsSaveOptions.md)

#### Returns

`Promise`<`void`>

***

### saveSync()

> **saveSync**(`path`, `limits?`, `options?`): `void`

Defined in: [packages/sheetkit/index.ts:1737](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1737)

Save the workbook to a .xlsx file using atomic replacement. See [SaveOptions](../interfaces/SaveOptions.md).

#### Parameters

##### path

`string`

##### limits?

[`SaveLimits`](../interfaces/SaveLimits.md) | [`JsSaveLimits`](../interfaces/JsSaveLimits.md)

##### options?

[`SaveOptions`](../interfaces/SaveOptions.md) | [`JsSaveOptions`](../interfaces/JsSaveOptions.md)

#### Returns

`void`

***

### saveWithPassword()

> **saveWithPassword**(`path`, `password`, `limits?`, `options?`): `Promise`<`void`>

Defined in: [packages/sheetkit/index.ts:1775](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1775)

Save the workbook as an encrypted .xlsx file asynchronously. Both sync and async encrypted saves buffer in memory before encrypting, so peak memory is similar.

#### Parameters

##### path

`string`

##### password

`string`

##### limits?

[`CryptLimits`](../interfaces/CryptLimits.md) | [`JsCryptLimits`](../interfaces/JsCryptLimits.md)

##### options?

[`SaveOptions`](../interfaces/SaveOptions.md) | [`JsSaveOptions`](../interfaces/JsSaveOptions.md)

#### Returns

`Promise`<`void`>

***

### saveWithPasswordSync()

> **saveWithPasswordSync**(`path`, `password`, `limits?`, `options?`): `void`

Defined in: [packages/sheetkit/index.ts:1765](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1765)

Save the workbook as an encrypted .xlsx file. See [SaveOptions](../interfaces/SaveOptions.md).

#### Parameters

##### path

`string`

##### password

`string`

##### limits?

[`CryptLimits`](../interfaces/CryptLimits.md) | [`JsCryptLimits`](../interfaces/JsCryptLimits.md)

##### options?

[`SaveOptions`](../interfaces/SaveOptions.md) | [`JsSaveOptions`](../interfaces/JsSaveOptions.md)

#### Returns

`void`

***

### setActiveSheet()

> **setActiveSheet**(`name`): `void`

Defined in: [packages/sheetkit/index.ts:1862](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1862)

Set the active sheet by name.

#### Parameters

##### name

`string`

#### Returns

`void`

***

### setAppProps()

> **setAppProps**(`props`): `void`

Defined in: [packages/sheetkit/index.ts:2174](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2174)

Set application properties (company, app version, etc.).

#### Parameters

##### props

[`JsAppProperties`](../interfaces/JsAppProperties.md)

#### Returns

`void`

***

### setAutoFilter()

> **setAutoFilter**(`sheet`, `range`): `void`

Defined in: [packages/sheetkit/index.ts:2132](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2132)

Set an auto-filter on a sheet.

#### Parameters

##### sheet

`string`

##### range

`string`

#### Returns

`void`

***

### setCellFormula()

> **setCellFormula**(`sheet`, `cell`, `formula`, `limits?`): `void`

Defined in: [packages/sheetkit/index.ts:2405](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2405)

Set a formula on a cell using finite mutation limits.

#### Parameters

##### sheet

`string`

##### cell

`string`

##### formula

`string`

##### limits?

[`FormulaLimits`](../interfaces/FormulaLimits.md)

#### Returns

`void`

***

### setCellHyperlink()

> **setCellHyperlink**(`sheet`, `cell`, `opts`): `void`

Defined in: [packages/sheetkit/index.ts:2288](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2288)

Set a hyperlink on a cell.

#### Parameters

##### sheet

`string`

##### cell

`string`

##### opts

[`JsHyperlinkOptions`](../interfaces/JsHyperlinkOptions.md)

#### Returns

`void`

***

### setCellRichText()

> **setCellRichText**(`sheet`, `cell`, `runs`): `void`

Defined in: [packages/sheetkit/index.ts:2488](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2488)

Set a cell to a rich text value with multiple formatted runs.

#### Parameters

##### sheet

`string`

##### cell

`string`

##### runs

[`JsRichTextRun`](../interfaces/JsRichTextRun.md)\[]

#### Returns

`void`

***

### setCellStyle()

> **setCellStyle**(`sheet`, `cell`, `styleId`): `void`

Defined in: [packages/sheetkit/index.ts:1962](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1962)

Apply a style ID to a cell.

#### Parameters

##### sheet

`string`

##### cell

`string`

##### styleId

`number`

#### Returns

`void`

***

### setCellValue()

> **setCellValue**(`sheet`, `cell`, `value`): `void`

Defined in: [packages/sheetkit/index.ts:1801](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1801)

Set the value of a cell. Pass string, number, boolean, DateValue, or null to clear.

#### Parameters

##### sheet

`string`

##### cell

`string`

##### value

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

#### Returns

`void`

***

### setCellValues()

> **setCellValues**(`sheet`, `cells`): `void`

Defined in: [packages/sheetkit/index.ts:1806](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1806)

Set multiple cell values at once.

#### Parameters

##### sheet

`string`

##### cells

[`JsCellEntry`](../interfaces/JsCellEntry.md)\[]

#### Returns

`void`

***

### setColOutlineLevel()

> **setColOutlineLevel**(`sheet`, `col`, `level`): `void`

Defined in: [packages/sheetkit/index.ts:1932](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1932)

Set the outline level of a column (0-7).

#### Parameters

##### sheet

`string`

##### col

`string`

##### level

`number`

#### Returns

`void`

***

### setColStyle()

> **setColStyle**(`sheet`, `col`, `styleId`): `void`

Defined in: [packages/sheetkit/index.ts:1977](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1977)

Apply a style ID to an entire column.

#### Parameters

##### sheet

`string`

##### col

`string`

##### styleId

`number`

#### Returns

`void`

***

### setColVisible()

> **setColVisible**(`sheet`, `col`, `visible`): `void`

Defined in: [packages/sheetkit/index.ts:1922](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1922)

Set whether a column is visible.

#### Parameters

##### sheet

`string`

##### col

`string`

##### visible

`boolean`

#### Returns

`void`

***

### setColWidth()

> **setColWidth**(`sheet`, `col`, `width`): `void`

Defined in: [packages/sheetkit/index.ts:1912](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1912)

Set the width of a column (e.g., "A", "B", "AA").

#### Parameters

##### sheet

`string`

##### col

`string`

##### width

`number`

#### Returns

`void`

***

### setConditionalFormat()

> **setConditionalFormat**(`sheet`, `sqref`, `rules`): `void`

Defined in: [packages/sheetkit/index.ts:2067](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2067)

Set conditional formatting rules on a cell range.

#### Parameters

##### sheet

`string`

##### sqref

`string`

##### rules

[`JsConditionalFormatRule`](../interfaces/JsConditionalFormatRule.md)\[]

#### Returns

`void`

***

### setCustomProperty()

> **setCustomProperty**(`name`, `value`): `void`

Defined in: [packages/sheetkit/index.ts:2184](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2184)

Set a custom property. Value can be string, number, or boolean.

#### Parameters

##### name

`string`

##### value

`string` | `number` | `boolean`

#### Returns

`void`

***

### setDefinedName()

> **setDefinedName**(`config`): `void`

Defined in: [packages/sheetkit/index.ts:2503](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2503)

Add or update a defined name.

#### Parameters

##### config

[`JsDefinedNameConfig`](../interfaces/JsDefinedNameConfig.md)

#### Returns

`void`

***

### setDocProps()

> **setDocProps**(`props`): `void`

Defined in: [packages/sheetkit/index.ts:2164](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2164)

Set core document properties (title, creator, etc.).

#### Parameters

##### props

[`JsDocProperties`](../interfaces/JsDocProperties.md)

#### Returns

`void`

***

### setHeaderFooter()

> **setHeaderFooter**(`sheet`, `header?`, `footer?`): `void`

Defined in: [packages/sheetkit/index.ts:2249](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2249)

Set header and footer text for printing.

#### Parameters

##### sheet

`string`

##### header?

`string` | `null`

##### footer?

`string` | `null`

#### Returns

`void`

***

### setPageMargins()

> **setPageMargins**(`sheet`, `margins`): `void`

Defined in: [packages/sheetkit/index.ts:2229](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2229)

Set page margins on a sheet (values in inches).

#### Parameters

##### sheet

`string`

##### margins

[`JsPageMargins`](../interfaces/JsPageMargins.md)

#### Returns

`void`

***

### setPageSetup()

> **setPageSetup**(`sheet`, `setup`): `void`

Defined in: [packages/sheetkit/index.ts:2239](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2239)

Set page setup options (paper size, orientation, scale, fit-to-page).

#### Parameters

##### sheet

`string`

##### setup

[`JsPageSetup`](../interfaces/JsPageSetup.md)

#### Returns

`void`

***

### setPanes()

> **setPanes**(`sheet`, `cell`): `void`

Defined in: [packages/sheetkit/index.ts:2214](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2214)

Set freeze panes on a sheet.

#### Parameters

##### sheet

`string`

##### cell

`string`

#### Returns

`void`

***

### setPrintOptions()

> **setPrintOptions**(`sheet`, `opts`): `void`

Defined in: [packages/sheetkit/index.ts:2263](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2263)

Set print options on a sheet.

#### Parameters

##### sheet

`string`

##### opts

[`JsPrintOptions`](../interfaces/JsPrintOptions.md)

#### Returns

`void`

***

### setRowHeight()

> **setRowHeight**(`sheet`, `row`, `height`): `void`

Defined in: [packages/sheetkit/index.ts:1882](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1882)

Set the height of a row (1-based).

#### Parameters

##### sheet

`string`

##### row

`number`

##### height

`number`

#### Returns

`void`

***

### setRowOutlineLevel()

> **setRowOutlineLevel**(`sheet`, `row`, `level`): `void`

Defined in: [packages/sheetkit/index.ts:1902](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1902)

Set the outline level of a row (0-7).

#### Parameters

##### sheet

`string`

##### row

`number`

##### level

`number`

#### Returns

`void`

***

### setRowStyle()

> **setRowStyle**(`sheet`, `row`, `styleId`): `void`

Defined in: [packages/sheetkit/index.ts:1967](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1967)

Apply a style ID to an entire row.

#### Parameters

##### sheet

`string`

##### row

`number`

##### styleId

`number`

#### Returns

`void`

***

### setRowValues()

> **setRowValues**(`sheet`, `row`, `startCol`, `values`): `void`

Defined in: [packages/sheetkit/index.ts:1814](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1814)

Set values in a single row starting from the given column.

#### Parameters

##### sheet

`string`

##### row

`number`

##### startCol

`string`

##### values

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

#### Returns

`void`

***

### setRowVisible()

> **setRowVisible**(`sheet`, `row`, `visible`): `void`

Defined in: [packages/sheetkit/index.ts:1892](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1892)

Set whether a row is visible.

#### Parameters

##### sheet

`string`

##### row

`number`

##### visible

`boolean`

#### Returns

`void`

***

### setSheetData()

> **setSheetData**(`sheet`, `data`, `startCell?`): `void`

Defined in: [packages/sheetkit/index.ts:1819](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1819)

Set a block of cell values from a 2D array.

#### Parameters

##### sheet

`string`

##### data

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

##### startCell?

`string` | `null`

#### Returns

`void`

***

### setSheetDataBuffer()

> **setSheetDataBuffer**(`sheet`, `buf`, `startCell?`): `void`

Defined in: [packages/sheetkit/index.ts:2395](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2395)

Apply cell data from a binary buffer to a sheet.

#### Parameters

##### sheet

`string`

##### buf

`Buffer`

##### startCell?

`string` | `null`

#### Returns

`void`

***

### setSheetName()

> **setSheetName**(`oldName`, `newName`): `void`

Defined in: [packages/sheetkit/index.ts:1842](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1842)

Rename a sheet.

#### Parameters

##### oldName

`string`

##### newName

`string`

#### Returns

`void`

***

### setSheetViewOptions()

> **setSheetViewOptions**(`sheet`, `opts`): `void`

Defined in: [packages/sheetkit/index.ts:2894](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2894)

Set sheet view options (gridlines, zoom, view mode, etc.).

#### Parameters

##### sheet

`string`

##### opts

[`JsSheetViewOptions`](../interfaces/JsSheetViewOptions.md)

#### Returns

`void`

***

### setSheetVisibility()

> **setSheetVisibility**(`sheet`, `visibility`): `void`

Defined in: [packages/sheetkit/index.ts:2904](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2904)

Set sheet visibility ("visible", "hidden", or "veryHidden").

#### Parameters

##### sheet

`string`

##### visibility

`string`

#### Returns

`void`

***

### toCSV()

> **toCSV**(`sheet`, `options?`): `string`

Defined in: [packages/sheetkit/index.ts:2666](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2666)

Convert sheet data to CSV. Formula cells export expressions regardless of
cached results. Records use LF by default without a trailing terminator.

#### Parameters

##### sheet

`string`

##### options?

[`ToCsvOptions`](../interfaces/ToCsvOptions.md)

#### Returns

`string`

***

### toHTML()

> **toHTML**(`sheet`, `options?`): `string`

Defined in: [packages/sheetkit/index.ts:2705](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2705)

Convert sheet data to an HTML table string.

#### Parameters

##### sheet

`string`

##### options?

[`ToHtmlOptions`](../interfaces/ToHtmlOptions.md)

#### Returns

`string`

***

### toJSON()

> **toJSON**(`sheet`, `options?`): `Record`<`string`, [`CellValue`](../type-aliases/CellValue.md)>\[]

Defined in: [packages/sheetkit/index.ts:2538](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2538)

Convert sheet data to an array of JSON objects.

#### Parameters

##### sheet

`string`

##### options?

[`ToJsonOptions`](../interfaces/ToJsonOptions.md)

#### Returns

`Record`<`string`, [`CellValue`](../type-aliases/CellValue.md)>\[]

***

### unmergeCell()

> **unmergeCell**(`sheet`, `reference`): `void`

Defined in: [packages/sheetkit/index.ts:2042](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2042)

Remove a merged cell range from a sheet.

#### Parameters

##### sheet

`string`

##### reference

`string`

#### Returns

`void`

***

### unprotectSheet()

> **unprotectSheet**(`sheet`): `void`

Defined in: [packages/sheetkit/index.ts:2528](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2528)

Remove sheet protection.

#### Parameters

##### sheet

`string`

#### Returns

`void`

***

### unprotectWorkbook()

> **unprotectWorkbook**(): `void`

Defined in: [packages/sheetkit/index.ts:2204](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2204)

Remove workbook protection.

#### Returns

`void`

***

### unsetPanes()

> **unsetPanes**(`sheet`): `void`

Defined in: [packages/sheetkit/index.ts:2219](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L2219)

Remove any freeze or split panes from a sheet.

#### Parameters

##### sheet

`string`

#### Returns

`void`

***

### writeBuffer()

> **writeBuffer**(`limits?`): `Promise`<`Buffer`<`ArrayBufferLike`>>

Defined in: [packages/sheetkit/index.ts:1760](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1760)

Serialize the workbook to an in-memory Buffer asynchronously.

#### Parameters

##### limits?

[`SaveLimits`](../interfaces/SaveLimits.md) | [`JsSaveLimits`](../interfaces/JsSaveLimits.md)

#### Returns

`Promise`<`Buffer`<`ArrayBufferLike`>>

***

### writeBufferSync()

> **writeBufferSync**(`limits?`): `Buffer`

Defined in: [packages/sheetkit/index.ts:1755](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1755)

Serialize the workbook to an in-memory Buffer.

#### Parameters

##### limits?

[`SaveLimits`](../interfaces/SaveLimits.md) | [`JsSaveLimits`](../interfaces/JsSaveLimits.md)

#### Returns

`Buffer`

***

### open()

> `static` **open**(`path`, `options?`): `Promise`<`Workbook`>

Defined in: [packages/sheetkit/index.ts:1664](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1664)

Open an existing .xlsx file from disk asynchronously.

#### Parameters

##### path

`string`

##### options?

[`OpenOptions`](../interfaces/OpenOptions.md) | [`JsOpenOptions`](../interfaces/JsOpenOptions.md) | `null`

#### Returns

`Promise`<`Workbook`>

***

### openBuffer()

> `static` **openBuffer**(`data`, `options?`): `Promise`<`Workbook`>

Defined in: [packages/sheetkit/index.ts:1680](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1680)

Open a workbook from an in-memory Buffer asynchronously.

#### Parameters

##### data

`Buffer`

##### options?

[`OpenOptions`](../interfaces/OpenOptions.md) | [`JsOpenOptions`](../interfaces/JsOpenOptions.md) | `null`

#### Returns

`Promise`<`Workbook`>

***

### openBufferSync()

> `static` **openBufferSync**(`data`, `options?`): `Workbook`

Defined in: [packages/sheetkit/index.ts:1672](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1672)

Open a workbook from an in-memory Buffer.

#### Parameters

##### data

`Buffer`

##### options?

[`OpenOptions`](../interfaces/OpenOptions.md) | [`JsOpenOptions`](../interfaces/JsOpenOptions.md) | `null`

#### Returns

`Workbook`

***

### openBufferWithPassword()

> `static` **openBufferWithPassword**(`data`, `password`, `options?`): `Promise`<`Workbook`>

Defined in: [packages/sheetkit/index.ts:1721](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1721)

Open an encrypted in-memory Buffer asynchronously.

#### Parameters

##### data

`Buffer`

##### password

`string`

##### options?

[`OpenOptions`](../interfaces/OpenOptions.md) | [`JsOpenOptions`](../interfaces/JsOpenOptions.md) | `null`

#### Returns

`Promise`<`Workbook`>

***

### openBufferWithPasswordSync()

> `static` **openBufferWithPasswordSync**(`data`, `password`, `options?`): `Workbook`

Defined in: [packages/sheetkit/index.ts:1710](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1710)

Open an encrypted workbook from an in-memory Buffer.

#### Parameters

##### data

`Buffer`

##### password

`string`

##### options?

[`OpenOptions`](../interfaces/OpenOptions.md) | [`JsOpenOptions`](../interfaces/JsOpenOptions.md) | `null`

#### Returns

`Workbook`

***

### openSync()

> `static` **openSync**(`path`, `options?`): `Workbook`

Defined in: [packages/sheetkit/index.ts:1656](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1656)

Open an existing .xlsx file from disk.

#### Parameters

##### path

`string`

##### options?

[`OpenOptions`](../interfaces/OpenOptions.md) | [`JsOpenOptions`](../interfaces/JsOpenOptions.md) | `null`

#### Returns

`Workbook`

***

### openWithPassword()

> `static` **openWithPassword**(`path`, `password`, `options?`): `Promise`<`Workbook`>

Defined in: [packages/sheetkit/index.ts:1699](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1699)

Open an encrypted .xlsx file using a password asynchronously.

#### Parameters

##### path

`string`

##### password

`string`

##### options?

[`OpenOptions`](../interfaces/OpenOptions.md) | [`JsOpenOptions`](../interfaces/JsOpenOptions.md) | `null`

#### Returns

`Promise`<`Workbook`>

***

### openWithPasswordSync()

> `static` **openWithPasswordSync**(`path`, `password`, `options?`): `Workbook`

Defined in: [packages/sheetkit/index.ts:1688](https://github.com/Nebu1eto/sheetkit/blob/aedd8c0c4ec37185210740b875ec6bb714d323d4/packages/sheetkit/index.ts#L1688)

Open an encrypted .xlsx file using a password.

#### Parameters

##### path

`string`

##### password

`string`

##### options?

[`OpenOptions`](../interfaces/OpenOptions.md) | [`JsOpenOptions`](../interfaces/JsOpenOptions.md) | `null`

#### Returns

`Workbook`
