Tableau Embedding API
    Preparing search index...

    Interface Story

    interface Story {
        activeStoryPoint: StoryPoint;
        index: number;
        isActive: boolean;
        isHidden: boolean;
        name: string;
        sheetType: SheetType;
        size: SheetSize;
        storyPointsInfo: StoryPointInfo[];
        url: string;
        workbook: Workbook;
        activateNextStoryPointAsync(): Promise<StoryPoint>;
        activatePreviousStoryPointAsync(): Promise<StoryPoint>;
        activateStoryPointAsync(index: number): Promise<StoryPoint>;
        changeSizeAsync(sheetSize: SheetSize): Promise<SheetSize>;
        revertStoryPointAsync(index: number): Promise<StoryPointInfo>;
    }

    Hierarchy (View Summary)

    Index

    Methods

    activateNextStoryPointAsync activatePreviousStoryPointAsync activateStoryPointAsync changeSizeAsync revertStoryPointAsync

    Properties

    activeStoryPoint index isActive isHidden name sheetType size storyPointsInfo url workbook

    Methods

    • Activates the next story point if there is one. If the current story point is the last one, then it stays active.

      Returns Promise<StoryPoint>

      A promise that resolves to the active StoryPoint.

    • Activates the previous story point if there is one. If the current story point is the first one, then it stays active.

      Returns Promise<StoryPoint>

      A promise that resolves to the active StoryPoint.

    • Activates the story point at the specified index and returns a promise of the activated StoryPoint. Throws a EmbeddingErrorCodes.IndexOutOfRange error if the index is less than zero or greater than or equal to the number of story points in the array.

      Parameters

      • index: number

      Returns Promise<StoryPoint>

      A promise that resolves to the active StoryPoint.

    • 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>

    • Reverts the story point at the specified index and returns a promise of the reverted StoryPointInfo. Throws a EmbeddingErrorCodes.IndexOutOfRange error if the index is less than zero or greater than or equal to the number of story points in the array.

      Parameters

      • index: number

      Returns Promise<StoryPointInfo>

      A promise that resolves to the reverted StoryPointInfo.

    Properties

    activeStoryPoint: StoryPoint

    The currently active story point.

    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.

    storyPointsInfo: StoryPointInfo[]

    An array of StoryPointInfo objects.

    url: string

    the URL for this sheet.

    workbook: Workbook

    The workbook containing this sheet

    Settings

    Member Visibility

    On This Page

    Methods
    Properties