workbookWorksheet resource type

Namespace: microsoft.graph

An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.

Methods

Method	Return Type	Description
Get worksheet	workbookWorksheet	Read properties and relationships of worksheet object.
Add 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.
Add table	workbookTable	Create a new Table by posting to the tables collection.
List tables	workbookTable collection	Get a Table object collection.
Update worksheet	workbookWorksheet	Update Worksheet object.
Get cell	Range	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.
Get range	Range	Gets the range object specified by the address or name.
Get usedrange	Range	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 worksheet	None	Deletes the worksheet from the workbook.
List	workbookWorksheet collection	Get worksheet object collection.
Add worksheet	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.

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

The following JSON representation shows the resource type.

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