---
schema_version: "1"
id: e04de643f44499ca81e592ecd06debe2e4aac60ac01dbed9a718aa28eb4ecdd5
title: Sheet | Tableau Embedding API
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/interfaces/Sheet.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Sheet.html
source_site: help.tableau.com
content_type: documentation
content_hash: 394f8f886d9751f22ec6589e5b922f3815183c80fd2975a0f95eb3e039092ee6
description: Documentation for Tableau Embedding API
---
- Sheet

# Interface Sheet

interface Sheet {  
    [index](#index): number;  
    [isActive](#isactive): boolean;  
    [isHidden](#ishidden): boolean;  
    [name](#name): string;  
    [sheetType](#sheettype): [SheetType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/SheetType.html);  
    [size](#size): [SheetSize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/SheetSize.html);  
    [url](#url): string;  
    [workbook](#workbook): [Workbook](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Workbook.html);  
    [changeSizeAsync](#changesizeasync-1)(sheetSize: [SheetSize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/SheetSize.html)): Promise<[SheetSize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/SheetSize.html)\>;  
}

#### Hierarchy ([View Summary](https://help.tableau.com/current/api/embedding_api/en-us/reference/hierarchy.html#Sheet))

- Sheet
    - [Dashboard](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Dashboard.html)
    - [Worksheet](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Worksheet.html)
    - [Story](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Story.html)

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:31

##### Index

### Methods

[changeSizeAsync](#changesizeasync)

### Properties

[index](#index) [isActive](#isactive) [isHidden](#ishidden) [name](#name) [sheetType](#sheettype) [size](#size) [url](#url) [workbook](#workbook)

## Methods

### changeSizeAsync[](#changesizeasync)

- changeSizeAsync(sheetSize: [SheetSize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/SheetSize.html)): Promise<[SheetSize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/SheetSize.html)\>[](#changesizeasync-1)
    
    Sets the size information of a sheet. Note that if the sheet is a Worksheet, only SheetSizeBehavior.Automatic is allowed since you can't actually set a Worksheet to a fixed size.
    
    #### Parameters
    
    - sheetSize: [SheetSize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/SheetSize.html)
    
    #### Returns Promise<[SheetSize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/SheetSize.html)\>
    
    - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:79

## Properties

### `Readonly`index[](#index)

index: number

#### Returns[](#returns)

The index of the sheet within the published tabs. Note that hidden tabs are still counted in the ordering, as long as they are published.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:58

### `Readonly`isActive[](#isactive)

isActive: boolean

#### Returns[](#returns-1)

A value indicating whether the sheet is the currently active sheet.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:45

### `Readonly`isHidden[](#ishidden)

isHidden: boolean

#### Returns[](#returns-2)

A value indicating whether the sheet is hidden (true) or visible (false) in the UI. Note that if the entire tab control is hidden, it does not affect the state of this flag. This sheet may still report that it is visible even when the tabs control is hidden.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:52

### `Readonly`name[](#name)

name: string

#### Returns[](#returns-3)

The name of the sheet.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:35

### `Readonly`sheetType[](#sheettype)

sheetType: [SheetType](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/SheetType.html)

#### Returns[](#returns-4)

The type of the sheet.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:40

### `Readonly`size[](#size)

size: [SheetSize](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/SheetSize.html)

#### Returns[](#returns-5)

The size information that the author specified when publishing the workbook.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:68

### `Readonly`url[](#url)

url: string

#### Returns[](#returns-6)

the URL for this sheet.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:63

### `Readonly`workbook[](#workbook)

workbook: [Workbook](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Workbook.html)

#### Returns[](#returns-7)

The workbook containing this sheet

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:73

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Methods

[changeSizeAsync](#changesizeasync)

Properties

[index](#index)[isActive](#isactive)[isHidden](#ishidden)[name](#name)[sheetType](#sheettype)[size](#size)[url](#url)[workbook](#workbook)