Salesforce Docs Portal

Sheet | Tableau Embedding API

Interface Sheet

interface Sheet {
    index: number;
    isActive: boolean;
    isHidden: boolean;
    name: string;
    sheetType: SheetType;
    size: SheetSize;
    url: string;
    workbook: Workbook;
    changeSizeAsync(sheetSize: SheetSize): Promise<SheetSize>;
}

Hierarchy (View Summary)

Index

Methods

changeSizeAsync

Properties

index isActive isHidden name sheetType size url workbook

Methods

  • 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

    Returns Promise<SheetSize>

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.

isHidden: boolean

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.

name: string

The name of the sheet.

sheetType: SheetType

The type of the sheet.

size: SheetSize

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

url: string

the URL for this sheet.

workbook: Workbook

The workbook containing this sheet

Settings

Member Visibility

On This Page

Methods
Properties