Worksheet resource type

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

Methods

Method Return Type Description
Get Worksheet Worksheet Read properties and relationships of worksheet object.
Create Chart Chart Create a new Chart by posting to the charts collection.
List names NamedItem collection Get named item collection associated with the worksheet.
List charts Chart collection Get a Chart object collection.
Create Table Table Create a new Table by posting to the tables collection.
List tables Table collection Get a Table object collection.
Update Worksheet Update Worksheet object.
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.
Range Range Gets the range object specified by the address or name.
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 None Deletes the worksheet from the workbook.
List Worksheet collection Get worksheet object collection.
Add Worksheet 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.

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 int The zero-based position of the worksheet within the workbook.
visibility string The Visibility of the worksheet. Possible values are: Visible, Hidden, VeryHidden.

Relationships

Relationship Type Description
charts Chart collection Returns collection of charts that are part of the worksheet. Read-only.
names NamedItem 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 WorksheetProtection Returns sheet protection object for a worksheet. Read-only.
tables Table collection Collection of tables that are part of the worksheet. Read-only.

JSON representation

Here is a JSON representation of the resource.

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