Interface: IWorksheetData

Snapshot of a worksheet.

Properties

Property	Type	Default value	Description
`cellData`	`IObjectMatrixPrimitiveType`<`ICellData`>	`undefined`	A matrix storing cell contents by row and column index.
`columnCount`	`number`	`undefined`	‐
`columnData`	`IObjectArrayPrimitiveType`<`Partial`<…>>	`undefined`	‐
`columnHeader`	{ `height`: `number`; `hidden`: `BooleanNumber`; }	`undefined`	‐
`columnHeader.height`	`number`	`undefined`	‐
`columnHeader.hidden?`	`BooleanNumber`	`undefined`	‐
`custom?`	`CustomData`	`undefined`	User stored custom fields
`defaultColumnWidth`	`number`	`undefined`	‐
`defaultRowHeight`	`number`	`undefined`	‐
`defaultStyle?`	`string` \| `Nullable`<…>	`undefined`	‐
`freeze`	`IFreeze`	`undefined`	‐
`gridlinesColor?`	`string`	`undefined`	Color of the gridlines.
`hidden`	`BooleanNumber`	`BooleanNumber.FALSE`	Determine whether the sheet is hidden. Remarks See the BooleanNumber enum for more details.
`id`	`string`	`undefined`	Id of the worksheet. This should be unique and immutable across the lifecycle of the worksheet.
`mergeData`	`IRange`[]	`undefined`	All merged cells in this worksheet.
`name`	`string`	`undefined`	Name of the sheet.
`rightToLeft`	`BooleanNumber`	`undefined`	‐
`rowCount`	`number`	`undefined`	‐
`rowData`	`IObjectArrayPrimitiveType`<`Partial`<…>>	`undefined`	‐
`rowHeader`	{ `hidden`: `BooleanNumber`; `width`: `number`; }	`undefined`	‐
`rowHeader.hidden?`	`BooleanNumber`	`undefined`	‐
`rowHeader.width`	`number`	`undefined`	‐
~~`scrollLeft`~~	`number`	`undefined`	Deprecated
~~`scrollTop`~~	`number`	`undefined`	Deprecated
`showGridlines`	`BooleanNumber`	`undefined`	‐
`tabColor`	`string`	`undefined`	‐
~~`zoomRatio`~~	`number`	`undefined`	Deprecated