Components / Spreadsheet / API / SheetDescriptor /

SheetDescriptor

Represents the interface of a Spreadsheet document sheet and its content.

Name	Type	Default	Description
activeCell?	`string`		The active cell in the sheet, for example, `A1`.
columns?	`SheetColumn[]`		An array which defines the columns in this sheet and their content.
defaultCellStyle?	`CellDefaultStyle`		The default cell styles that will be applied to the sheet cells.
drawings?	`{ height: number; image: string; offsetX: number; offsetY: number; opacity: any; topLeftCell: any; width: number; }[]`		An array which contains the drawings used in this sheet.
frozenColumns?	`number`		The number of frozen columns in this sheet.
frozenRows?	`number`		The number of frozen rows in this sheet.
hyperlinks?	`{ ref: string; target: string; }[]`		An array which contains the hyperlinks of the cells.
mergedCells?	`string[]`		An array of merged cell ranges, for example, `B1:D2`.
name?	`string`		The name of the sheet.
rows?	`SheetRow[]`		The row data for this sheet.
selection?	`string`		The selected range in the sheet, for example, `A1:B10`.
showGridLines?	`boolean`	`true`	A Boolean value which indicates if the grid lines of the sheet will be displayed.
state?	`"visible" \| "hidden" \| "veryHidden"`	`'visible'`	The state of the sheet.