Edit

Excel.Interfaces.WorksheetData interface

  • Reference
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.
standardHeight

Returns the standard (default) height of all the rows in the worksheet, in points.
standardWidth

Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used.
tabColor

The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be null. If the worksheet is visible but the tab color is set to auto, an empty string will be returned. Otherwise, the property will be set to a color, in the form #RRGGBB (e.g., "FFA500"). When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.
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 ]

standardHeight

Returns the standard (default) height of all the rows in the worksheet, in points.

standardHeight?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

standardWidth

Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is used.

standardWidth?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

tabColor

The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be null. If the worksheet is visible but the tab color is set to auto, an empty string will be returned. Otherwise, the property will be set to a color, in the form #RRGGBB (e.g., "FFA500"). When setting the color, use an empty-string to set an "auto" color, or a real color otherwise.

tabColor?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

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. ]