API Reference

IWorksheetData

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

TypeScript

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

Definition

TypeScript

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.

Package: @univerjs/core · Type definitions

How is this guide?