Excel.Interfaces.WorksheetData interface

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

Properties

autoFilter

Represents the AutoFilter object of the worksheet.

charts

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

comments

Returns a collection of all the Comments objects on the worksheet.

customProperties

Gets a collection of worksheet-level custom properties.

enableCalculation

Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet.

horizontalPageBreaks

Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks.

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. The name must be fewer than 32 characters.

names

Collection of names scoped to the current worksheet.

pageLayout

Gets the PageLayout object of the 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.

shapes

Returns the collection of all the Shape objects on the worksheet.

showGridlines

Specifies if gridlines are visible to the user.

showHeadings

Specifies if headings are visible to the user.

slicers

Returns a collection of slicers that are part of the 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.

tabId

Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which is different from worksheet.id (which returns a globally unique identifier) and worksheet.name (which returns a value such as "Sheet1").

tables

Collection of tables that are part of the worksheet.

verticalPageBreaks

Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks.

visibility

The visibility of the worksheet.

Property Details

autoFilter

Represents the AutoFilter object of the worksheet.

autoFilter?: Excel.Interfaces.AutoFilterData;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

charts

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

charts?: Excel.Interfaces.ChartData[];

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

comments

Returns a collection of all the Comments objects on the worksheet.

comments?: Excel.Interfaces.CommentData[];

Property Value

Remarks

[ API set: ExcelApi 1.10 ]

customProperties

Gets a collection of worksheet-level custom properties.

customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];

Property Value

Remarks

[ API set: ExcelApi 1.12 ]

enableCalculation

Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when necessary. False if Excel doesn't recalculate the sheet.

enableCalculation?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

horizontalPageBreaks

Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks.

horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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. The name must be fewer than 32 characters.

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

Remarks

[ API set: ExcelApi 1.4 ]

pageLayout

Gets the PageLayout object of the worksheet.

pageLayout?: Excel.Interfaces.PageLayoutData;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

pivotTables

Collection of PivotTables that are part of the worksheet.

pivotTables?: Excel.Interfaces.PivotTableData[];

Property Value

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

Remarks

[ API set: ExcelApi 1.2 ]

shapes

Returns the collection of all the Shape objects on the worksheet.

shapes?: Excel.Interfaces.ShapeData[];

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

showGridlines

Specifies if gridlines are visible to the user.

showGridlines?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

showHeadings

Specifies if headings are visible to the user.

showHeadings?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

slicers

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

slicers?: Excel.Interfaces.SlicerData[];

Property Value

Remarks

[ API set: ExcelApi 1.10 ]

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 ]

tabId

Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which is different from worksheet.id (which returns a globally unique identifier) and worksheet.name (which returns a value such as "Sheet1").

tabId?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.14 ]

tables

Collection of tables that are part of the worksheet.

tables?: Excel.Interfaces.TableData[];

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

verticalPageBreaks

Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks.

verticalPageBreaks?: Excel.Interfaces.PageBreakData[];

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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