Skip to content

API reference / Common / SheetInfo

Interface: SheetInfo ​

A sheet of the open workbook, as UDocBase.sheets lists it.

Properties ​

PropertyDescription
name
string
The sheet's name, as its tab shows it; "" for one the workbook left unnamed.
visibility
"hidden" | "visible" | "veryHidden"
Whether the sheet shows: "visible", or one with no tab — "hidden", which Excel lets its user unhide, or "veryHidden", which it doesn't. Only a visible sheet can be shown, by its tab or UDocBase.goToSheet.
color
string | null | undefined
Its tab's color as #rrggbb, or null for a tab in no color. A sheet's color is known once the sheet has loaded, undefined until then: the workbook's sheets load in the background once it opens, a sheet shown at once, and "sheets:changed" fires as each color becomes known.