---
schema_version: "1"
id: 7ebae2e7a604524c3c28ec6107fb0b5d4b417e3912e4764f7940a116b3f9703c
title: SheetInfo | 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/SheetInfo.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/SheetInfo.html
source_site: help.tableau.com
content_type: documentation
content_hash: e07dac94084b27e2e7edbf424643432fd5a4cd108cb0e61b6749a4cee58a9645
description: Documentation for Tableau Embedding API
---
- SheetInfo

# Interface SheetInfo

interface SheetInfo {  
    [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);  
}

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

##### Index

### Properties

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

## 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:772

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

isActive: boolean

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

a value indicating whether the sheet is the currently active sheet. Due to a technical limitation, this will always return false if the object is a Worksheet instance that is part of a Dashboard.

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

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

isHidden: boolean

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

a value indicating whether the sheet is hidden 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:785

### `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:766

### `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. SheetType is an enum with the following values: WORKSHEET, DASHBOARD and STORY.

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

### `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:805

### `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:800

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

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

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

The Workbook to which this Sheet belongs.

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

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

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