Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
An interface describing the data returned by calling worksheet.toJSON()
.
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. The name must be fewer than 32 characters. |
names | Collection of names scoped to the current worksheet. |
notes | Returns a collection of all the notes objects in the 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 data type icons are visible on the worksheet. By default, data type icons are visible. |
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. |
Represents the AutoFilter
object of the worksheet.
autoFilter?: Excel.Interfaces.AutoFilterData;
Returns a collection of charts that are part of the worksheet.
charts?: Excel.Interfaces.ChartData[];
Returns a collection of all the Comments objects on the worksheet.
comments?: Excel.Interfaces.CommentData[];
Gets a collection of worksheet-level custom properties.
customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];
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;
boolean
Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks.
horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];
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;
string
The display name of the worksheet. The name must be fewer than 32 characters.
name?: string;
string
Collection of names scoped to the current worksheet.
names?: Excel.Interfaces.NamedItemData[];
Returns a collection of all the notes objects in the worksheet.
notes?: Excel.Interfaces.NoteData[];
Gets the PageLayout
object of the worksheet.
pageLayout?: Excel.Interfaces.PageLayoutData;
Collection of PivotTables that are part of the worksheet.
pivotTables?: Excel.Interfaces.PivotTableData[];
The zero-based position of the worksheet within the workbook.
position?: number;
number
Returns the sheet protection object for a worksheet.
protection?: Excel.Interfaces.WorksheetProtectionData;
Returns the collection of all the Shape objects on the worksheet.
shapes?: Excel.Interfaces.ShapeData[];
Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
showDataTypeIcons?: boolean;
boolean
Specifies if gridlines are visible to the user.
showGridlines?: boolean;
boolean
Specifies if headings are visible to the user.
showHeadings?: boolean;
boolean
Returns a collection of slicers that are part of the worksheet.
slicers?: Excel.Interfaces.SlicerData[];
Returns the standard (default) height of all the rows in the worksheet, in points.
standardHeight?: number;
number
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;
number
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;
string
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;
number
Collection of tables that are part of the worksheet.
tables?: Excel.Interfaces.TableData[];
Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks.
verticalPageBreaks?: Excel.Interfaces.PageBreakData[];
The visibility of the worksheet.
visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";
Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"
[ API set: ExcelApi 1.1 for reading visibility; 1.2 for setting it. ]
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback:
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign in