# IWorksheetData

- Human documentation: [https://docs.univer.ai/reference/types/worksheet-data](https://docs.univer.ai/reference/types/worksheet-data)

- Agent Markdown: [https://docs.univer.ai/reference/types/worksheet-data.md](https://docs.univer.ai/reference/types/worksheet-data.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [types/worksheet-data.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/types/worksheet-data.mdx)

---

The data for one worksheet: cells, row and column sizes, merged ranges, and display settings. Workbooks store sheets under `IWorkbookData.sheets`; each key matches the corresponding sheet ID in `sheetOrder`.

## Import

```ts
import type { IWorksheetData } from '@univerjs/core'
```

## Definition

```ts
interface IWorksheetData {
  id: string

  name: string
  tabColor: string

  hidden: BooleanNumber
  freeze: IFreeze
  rowCount: number
  columnCount: number
  zoomRatio: number
  scrollTop: number
  scrollLeft: number
  defaultColumnWidth: number
  defaultRowHeight: number

  mergeData: IRange[]

  cellData: IObjectMatrixPrimitiveType<ICellData>
  rowData: IObjectArrayPrimitiveType<Partial<IRowData>>
  columnData: IObjectArrayPrimitiveType<Partial<IColumnData>>

  defaultStyle?: Nullable<IStyleData> | string
  rowHeader: {
    width: number
    hidden?: BooleanNumber
  }
  columnHeader: {
    height: number
    hidden?: BooleanNumber
  }
  showGridlines: BooleanNumber

  gridlinesColor?: string
  rightToLeft: BooleanNumber

  custom?: CustomData
}
```

## Fields

### `id`

Required · `string`

Id of the worksheet. This should be unique and immutable across the lifecycle of the worksheet.

### `name`

Required · `string`

Name of the sheet.

### `tabColor`

Required · `string`

### `hidden`

Required · `BooleanNumber`

Determine whether the sheet is hidden.

### `freeze`

Required · `IFreeze`

### `rowCount`

Required · `number`

### `columnCount`

Required · `number`

### `zoomRatio`

Required · `number`

### `scrollTop`

Required · `number`

### `scrollLeft`

Required · `number`

### `defaultColumnWidth`

Required · `number`

### `defaultRowHeight`

Required · `number`

### `mergeData`

Required · `IRange[]`

All merged cells in this worksheet.

### `cellData`

Required · `IObjectMatrixPrimitiveType<ICellData>`

A matrix storing cell contents by row and column index.

### `rowData`

Required · `IObjectArrayPrimitiveType<Partial<IRowData>>`

### `columnData`

Required · `IObjectArrayPrimitiveType<Partial<IColumnData>>`

### `defaultStyle`

Optional · `string | Nullable<IStyleData>`

### `rowHeader`

Required · `{ width: number; hidden?: BooleanNumber | undefined; }`

### `columnHeader`

Required · `{ height: number; hidden?: BooleanNumber | undefined; }`

### `showGridlines`

Required · `BooleanNumber`

### `gridlinesColor`

Optional · `string | undefined`

Color of the gridlines.

### `rightToLeft`

Required · `BooleanNumber`

### `custom`

Optional · `CustomData`

User stored custom fields.

## Related types

* [`BooleanNumber`](https://docs.univer.ai/reference/enums/boolean-number.md)
* [`IFreeze`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/sheets/typedef.d.ts)
* [`IRange`](https://docs.univer.ai/reference/types/range.md)
* [`ICellData`](https://docs.univer.ai/reference/types/cell-data.md)
* [`IObjectMatrixPrimitiveType`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/shared/object-matrix.d.ts)
* [`Partial`](https://unpkg.com/@typescript/typescript-darwin-arm64@7.0.2/lib/lib.es5.d.ts)
* [`IRowData`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/sheets/typedef.d.ts)
* [`IObjectArrayPrimitiveType`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/shared/object-matrix.d.ts)
* [`IColumnData`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/sheets/typedef.d.ts)
* [`Nullable`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/shared/types.d.ts)
* [`IStyleData`](https://docs.univer.ai/reference/types/style-data.md)
* [`CustomData`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/sheets/typedef.d.ts)

**Package:** [`@univerjs/core`](https://docs.univer.ai/reference/packages/plugins/univerjs/core.md) · [Type definitions](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/sheets/typedef.d.ts)