Excel.Interfaces.WorksheetData interface
An interface describing the data returned by calling worksheet.toJSON().
Properties
| auto |
Represents the |
| charts | Returns a collection of charts that are part of the worksheet. |
| comments | Returns a collection of all the Comments objects on the worksheet. |
| custom |
Gets a collection of worksheet-level custom properties. |
| enable |
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. |
| horizontal |
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. |
| names | Collection of names scoped to the current worksheet. |
| page |
Gets the |
| pivot |
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. |
| show |
Specifies if gridlines are visible to the user. |
| show |
Specifies if headings are visible to the user. |
| slicers | Returns a collection of slicers that are part of the worksheet. |
| standard |
Returns the standard (default) height of all the rows in the worksheet, in points. |
| standard |
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. |
| tab |
The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be |
| tab |
Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which is different from |
| tables | Collection of tables that are part of the worksheet. |
| vertical |
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
charts
Returns a collection of charts that are part of the worksheet.
charts?: Excel.Interfaces.ChartData[];Property Value
Remarks
comments
Returns a collection of all the Comments objects on the worksheet.
comments?: Excel.Interfaces.CommentData[];Property Value
Remarks
customProperties
Gets a collection of worksheet-level custom properties.
customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];Property Value
Remarks
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
horizontalPageBreaks
Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks.
horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];Property Value
Remarks
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
name
The display name of the worksheet.
name?: string;Property Value
string
Remarks
names
Collection of names scoped to the current worksheet.
names?: Excel.Interfaces.NamedItemData[];Property Value
Remarks
pageLayout
Gets the PageLayout object of the worksheet.
pageLayout?: Excel.Interfaces.PageLayoutData;Property Value
Remarks
pivotTables
Collection of PivotTables that are part of the worksheet.
pivotTables?: Excel.Interfaces.PivotTableData[];Property Value
Remarks
position
The zero-based position of the worksheet within the workbook.
position?: number;Property Value
number
Remarks
protection
Returns the sheet protection object for a worksheet.
protection?: Excel.Interfaces.WorksheetProtectionData;Property Value
Remarks
shapes
Returns the collection of all the Shape objects on the worksheet.
shapes?: Excel.Interfaces.ShapeData[];Property Value
Remarks
showGridlines
Specifies if gridlines are visible to the user.
showGridlines?: boolean;Property Value
boolean
Remarks
showHeadings
Specifies if headings are visible to the user.
showHeadings?: boolean;Property Value
boolean
Remarks
slicers
Returns a collection of slicers that are part of the worksheet.
slicers?: Excel.Interfaces.SlicerData[];Property Value
Remarks
standardHeight
Returns the standard (default) height of all the rows in the worksheet, in points.
standardHeight?: number;Property Value
number
Remarks
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
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
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
tables
Collection of tables that are part of the worksheet.
tables?: Excel.Interfaces.TableData[];Property Value
Remarks
verticalPageBreaks
Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks.
verticalPageBreaks?: Excel.Interfaces.PageBreakData[];Property Value
Remarks
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. ]
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for