Excel.Interfaces.WorksheetData interface

Package:

excel

An interface describing the data returned by calling worksheet.toJSON().

Properties

charts	Returns a collection of charts that are part of the worksheet.
id	Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved.
name	The display name of the worksheet.
names	Collection of names scoped to the current worksheet.
pivotTables	Collection of PivotTables that are part of the worksheet.
position	The zero-based position of the worksheet within the workbook.
protection	Returns the sheet protection object for a worksheet.
tables	Collection of tables that are part of the worksheet.
visibility	The visibility of the worksheet.

Property Details

charts

Returns a collection of charts that are part of the worksheet.

charts?: Excel.Interfaces.ChartData[];

Property Value

Excel.Interfaces.ChartData[]

Remarks

[ API set: ExcelApi 1.1 ]

id

Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

name

The display name of the worksheet.

name?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

names

Collection of names scoped to the current worksheet.

names?: Excel.Interfaces.NamedItemData[];

Property Value

Excel.Interfaces.NamedItemData[]

Remarks

[ API set: ExcelApi 1.4 ]

pivotTables

Collection of PivotTables that are part of the worksheet.

pivotTables?: Excel.Interfaces.PivotTableData[];

Property Value

Excel.Interfaces.PivotTableData[]

Remarks

[ API set: ExcelApi 1.3 ]

position

The zero-based position of the worksheet within the workbook.

position?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

protection

Returns the sheet protection object for a worksheet.

protection?: Excel.Interfaces.WorksheetProtectionData;

Property Value

Excel.Interfaces.WorksheetProtectionData

Remarks

[ API set: ExcelApi 1.2 ]

tables

Collection of tables that are part of the worksheet.

tables?: Excel.Interfaces.TableData[];

Property Value

Excel.Interfaces.TableData[]

Remarks

[ API set: ExcelApi 1.1 ]

visibility

The visibility of the worksheet.

visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Property Value

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Remarks

[ API set: ExcelApi 1.1 for reading visibility; 1.2 for setting it. ]