title	workbookWorksheet resource type
description	Represnts an Excel worksheet, which contains a grid of cells. It can contain data, tables, charts, and so on.
ms.localizationpriority	high
author	lumine2008
ms.subservice	excel
doc_type	resourcePageType
toc.title	Worksheet
ms.date	07/30/2024

workbookWorksheet resource type

Namespace: microsoft.graph

Represnts an Excel worksheet, which contains a grid of cells. It can contain data, tables, charts, and so on.

Methods

Method	Return Type	Description
List	workbookWorksheet collection	Get the list of worksheets in the workbook.
Add	workbookWorksheet	Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets.
Get	workbookWorksheet	Read the properties and relationships of the workbookWorksheet object.
Update	workbookWorksheet	Update a workbookWorksheet object.
Delete	None	Delete the worksheet from the workbook.
List charts	workbookChart collection	Get a list of the charts in the worksheet.
Add chart	workbookChart	Create a new chart by posting to the charts collection.
List names	workbookNamedItem collection	Get the list of workbookNamedItem objects for the worksheet.
List pivot tables	workbookPivotTable collection	Get a list of the pivot tables in the worksheet.
List tables	workbookTable collection	Get the list of tables in the worksheet.
Add table	workbookTable	Create a new table by posting to the tables collection.
Get cell	workbookRange	Get the range object that contains the single cell, specified by row and column numbers. The cell can be outside the bounds of its parent range, so long as it is within the worksheet grid.
Get range	workbookRange	Get the range object specified by the address or name.
Get used range	workbookRange	Get 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.

Property	Type	Description
id	string	The unique identifier for the worksheet in the 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	int	The zero-based position of the worksheet within the workbook.
visibility	string	The visibility of the worksheet. The possible values are: `Visible`, `Hidden`, `VeryHidden`.

Relationship	Type	Description
charts	workbookChart collection	The list of charts that are part of the worksheet. Read-only.
names	workbookNamedItem collection	The list of names that are associated with the worksheet. Read-only.
pivotTables	workbookPivotTable collection	The list of piot tables that are part of the worksheet.
protection	workbookWorksheetProtection	The sheet protection object for a worksheet. Read-only.
tables	workbookTable collection	The list of tables that are part of the worksheet. Read-only.

The following JSON representation shows the resource type.

{
  "id": "string",
  "name": "string",
  "position": 1024,
  "visibility": "string"
}