workbookWorksheet resource type
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
An Excel worksheet is a grid of cells. It can contain data, tables, charts, and so on.
Methods
Method | Return Type | Description |
---|---|---|
Get Worksheet | workbookWorksheet | Read properties and relationships of worksheet object. |
Create Chart | workbookChart | Create a new Chart by posting to the charts collection. |
List names | workbookNamedItem collection | Get named item collection associated with the worksheet. |
List charts | workbookChart collection | Get a Chart object collection. |
Create Table | workbookTable | Create a new Table by posting to the tables collection. |
List tables | workbookTable collection | Get a Table object collection. |
Update | workbookWorksheet | Update Worksheet object. |
Cell | workbookRange | Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it's stays within the worksheet grid. |
Range | workbookRange | Gets the range object specified by the address or name. |
Usedrange | workbookRange | The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the worksheet is blank, this function will return the top left cell. |
Delete | None | Deletes the worksheet from the workbook. |
List | workbookWorksheet collection | Get worksheet object collection. |
Add | workbookWorksheet | Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. |
List pivotTables | workbookPivotTable collection | Get a workbookPivotTable object collection. |
List tasks | workbookDocumentTask collection | Get a list of workbookDocumentTask objects. |
Properties
Property | Type | Description |
---|---|---|
id | String | 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. Read-only. |
name | String | The display name of the worksheet. |
position | Int32 | The zero-based position of the worksheet within the workbook. |
visibility | String | The visibility of the worksheet. The possible values are: Visible , Hidden , VeryHidden . |
Relationships
Relationship | Type | Description |
---|---|---|
charts | workbookChart collection | Returns collection of charts that are part of the worksheet. Read-only. |
names | workbookNamedItem collection | Returns collection of names that are associated with the worksheet. Read-only. |
pivotTables | workbookPivotTable collection | Collection of PivotTables that are part of the worksheet. |
protection | workbookWorksheetProtection | Returns sheet protection object for a worksheet. Read-only. |
tables | workbookTable collection | Collection of tables that are part of the worksheet. Read-only. |
tasks | workbookDocumentTask collection | Collection of document tasks on this worksheet. Read-only. |
JSON representation
The following is a JSON representation of the resource.
{
"id": "String (identifier)",
"name": "String",
"position": "Int32",
"visibility": "String"
}
Feedback
https://aka.ms/ContentUserFeedback.
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:Submit and view feedback for