Interface: IWorksheetData
Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:87
Snapshot of a worksheet.
Properties
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
cellData | IObjectMatrixPrimitiveType<ICellData> | undefined | A matrix storing cell contents by row and column index. | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:125 |
columnCount | number | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:111 |
columnData | IObjectArrayPrimitiveType<Partial<IColumnData>> | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:127 |
columnHeader | { height: number; hidden: BooleanNumber; } | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:139 |
columnHeader.height | number | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:140 |
columnHeader.hidden? | BooleanNumber | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:141 |
custom? | CustomData | undefined | User stored custom fields | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:155 |
defaultColumnWidth | number | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:118 |
defaultRowHeight | number | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:119 |
defaultStyle? | | string | Nullable<IStyleData> | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:132 |
freeze | IFreeze | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:108 |
gridlinesColor? | string | undefined | Color of the gridlines. | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:148 |
hidden | BooleanNumber | BooleanNumber.FALSE | Determine whether the sheet is hidden. Remarks See the BooleanNumber enum for more details. | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:106 |
id | string | undefined | Id of the worksheet. This should be unique and immutable across the lifecycle of the worksheet. | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:91 |
mergeData | IRange[] | undefined | All merged cells in this worksheet. | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:122 |
name | string | undefined | Name of the sheet. | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:94 |
rightToLeft | BooleanNumber | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:150 |
rowCount | number | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:110 |
rowData | IObjectArrayPrimitiveType<Partial<IRowData>> | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:126 |
rowHeader | { hidden: BooleanNumber; width: number; } | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:134 |
rowHeader.hidden? | BooleanNumber | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:136 |
rowHeader.width | number | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:135 |
scrollLeft | number | undefined | Deprecated | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:117 |
scrollTop | number | undefined | Deprecated | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:115 |
showGridlines | BooleanNumber | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:144 |
tabColor | string | undefined | - | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:96 |
zoomRatio | number | undefined | Deprecated | packages/api/tmp/univer-pro/submodules/univer/packages/core/src/sheets/typedef.ts:113 |