Salesforce Docs Portal

SheetInfo | Tableau Embedding API

Interface SheetInfo

interface SheetInfo {
    index: number;
    isActive: boolean;
    isHidden: boolean;
    name: string;
    sheetType: SheetType;
    size: SheetSize;
    url: string;
    workbook: Workbook;
}
Index

Properties

index isActive isHidden name sheetType size url workbook

Properties

index: number

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.

isActive: boolean

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.

isHidden: boolean

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.

name: string

the name of the sheet.

sheetType: SheetType

The type of the sheet. SheetType is an enum with the following values: WORKSHEET, DASHBOARD and STORY.

size: SheetSize

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

url: string

The URL for this sheet.

workbook: Workbook

The Workbook to which this Sheet belongs.

Settings

Member Visibility

On This Page

Properties