--- schema_version: "1" id: d5973d617047d51b40b213df6fb8ef9c1f0893dd387316bc9a0554e0f0a6d84b title: Story | Tableau Embedding API collection: tableau version: next locale: en-us portal_url: https://docs.salesforce.com/tableau/next/en-us/api/embedding_api/reference/interfaces/Story.md canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Story.html source_site: help.tableau.com content_type: documentation content_hash: 97d9771bed48e19017542745872a09721e9ad066388e42a29f15ca059d3e9d74 description: Documentation for Tableau Embedding API --- - Story # Interface Story interface Story {     [activeStoryPoint](#activestorypoint): [StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html);     [index](#index): number;     [isActive](#isactive): boolean;     [isHidden](#ishidden): boolean;     [name](#name): string;     [sheetType](#sheettype): [SheetType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/SheetType.html);     [size](#size): [SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html);     [storyPointsInfo](#storypointsinfo): [StoryPointInfo](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPointInfo.html)\[\];     [url](#url): string;     [workbook](#workbook): [Workbook](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Workbook.html);     [activateNextStoryPointAsync](#activatenextstorypointasync-1)(): Promise<[StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html)\>;     [activatePreviousStoryPointAsync](#activatepreviousstorypointasync-1)(): Promise<[StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html)\>;     [activateStoryPointAsync](#activatestorypointasync-1)(index: number): Promise<[StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html)\>;     [changeSizeAsync](#changesizeasync-1)(sheetSize: [SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html)): Promise<[SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html)\>;     [revertStoryPointAsync](#revertstorypointasync-1)(index: number): Promise<[StoryPointInfo](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPointInfo.html)\>; } #### Hierarchy ([View Summary](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/hierarchy.html#Story)) - [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html) - Story - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:3 ##### Index ### Methods [activateNextStoryPointAsync](#activatenextstorypointasync) [activatePreviousStoryPointAsync](#activatepreviousstorypointasync) [activateStoryPointAsync](#activatestorypointasync) [changeSizeAsync](#changesizeasync) [revertStoryPointAsync](#revertstorypointasync) ### Properties [activeStoryPoint](#activestorypoint) [index](#index) [isActive](#isactive) [isHidden](#ishidden) [name](#name) [sheetType](#sheettype) [size](#size) [storyPointsInfo](#storypointsinfo) [url](#url) [workbook](#workbook) ## Methods ### activateNextStoryPointAsync[](#activatenextstorypointasync) - activateNextStoryPointAsync(): Promise<[StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html)\>[](#activatenextstorypointasync-1) 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](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html)\> A promise that resolves to the active [StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html). - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:18 ### activatePreviousStoryPointAsync[](#activatepreviousstorypointasync) - activatePreviousStoryPointAsync(): Promise<[StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html)\>[](#activatepreviousstorypointasync-1) 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](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html)\> A promise that resolves to the active [StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html). - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:24 ### activateStoryPointAsync[](#activatestorypointasync) - activateStoryPointAsync(index: number): Promise<[StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html)\>[](#activatestorypointasync-1) Activates the story point at the specified index and returns a promise of the activated StoryPoint. Throws a [EmbeddingErrorCodes.IndexOutOfRange](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/EmbeddingErrorCodes.html#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](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html)\> A promise that resolves to the active [StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html). - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:32 ### changeSizeAsync[](#changesizeasync) - changeSizeAsync(sheetSize: [SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html)): Promise<[SheetSize](https://help.tableau.com/v0.0/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/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html) #### Returns Promise<[SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html)\> Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[changeSizeAsync](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#changesizeasync) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:79 ### revertStoryPointAsync[](#revertstorypointasync) - revertStoryPointAsync(index: number): Promise<[StoryPointInfo](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPointInfo.html)\>[](#revertstorypointasync-1) Reverts the story point at the specified index and returns a promise of the reverted StoryPointInfo. Throws a [EmbeddingErrorCodes.IndexOutOfRange](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/EmbeddingErrorCodes.html#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](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPointInfo.html)\> A promise that resolves to the reverted [StoryPointInfo](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPointInfo.html). - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:40 ## Properties ### `Readonly`activeStoryPoint[](#activestorypoint) activeStoryPoint: [StoryPoint](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPoint.html) #### Returns[](#returns) The currently active story point. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:7 ### `Readonly`index[](#index) index: number #### Returns[](#returns-1) 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. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[index](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#index) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:58 ### `Readonly`isActive[](#isactive) isActive: boolean #### Returns[](#returns-2) A value indicating whether the sheet is the currently active sheet. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[isActive](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#isactive) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:45 ### `Readonly`isHidden[](#ishidden) isHidden: boolean #### Returns[](#returns-3) 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. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[isHidden](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#ishidden) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:52 ### `Readonly`name[](#name) name: string #### Returns[](#returns-4) The name of the sheet. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[name](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#name) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:35 ### `Readonly`sheetType[](#sheettype) sheetType: [SheetType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/enums/SheetType.html) #### Returns[](#returns-5) The type of the sheet. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[sheetType](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#sheettype) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:40 ### `Readonly`size[](#size) size: [SheetSize](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/SheetSize.html) #### Returns[](#returns-6) The size information that the author specified when publishing the workbook. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[size](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#size) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:68 ### `Readonly`storyPointsInfo[](#storypointsinfo) storyPointsInfo: [StoryPointInfo](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPointInfo.html)\[\] #### Returns[](#returns-7) An array of StoryPointInfo objects. - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:12 ### `Readonly`url[](#url) url: string #### Returns[](#returns-8) the URL for this sheet. Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[url](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#url) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:63 ### `Readonly`workbook[](#workbook) workbook: [Workbook](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Workbook.html) #### Returns[](#returns-9) The workbook containing this sheet Inherited from [Sheet](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html).[workbook](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Sheet.html#workbook) - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/SheetInterfaces.ts:73 ### Settings Member Visibility - Protected - Inherited - External ThemeOSLightDark ### On This Page Methods [activateNextStoryPointAsync](#activatenextstorypointasync)[activatePreviousStoryPointAsync](#activatepreviousstorypointasync)[activateStoryPointAsync](#activatestorypointasync)[changeSizeAsync](#changesizeasync)[revertStoryPointAsync](#revertstorypointasync) Properties [activeStoryPoint](#activestorypoint)[index](#index)[isActive](#isactive)[isHidden](#ishidden)[name](#name)[sheetType](#sheettype)[size](#size)[storyPointsInfo](#storypointsinfo)[url](#url)[workbook](#workbook)