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

# Interface StoryPoint

interface StoryPoint {  
    [active](#active): boolean;  
    [caption](#caption): string;  
    [containedSheet](#containedsheet): undefined | [Sheet](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Sheet.html);  
    [index](#index): number;  
    [parentStory](#parentstory): [Story](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Story.html);  
    [updated](#updated): boolean;  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:43

##### Index

### Properties

[active](#active) [caption](#caption) [containedSheet](#containedsheet) [index](#index) [parentStory](#parentstory) [updated](#updated)

## Properties

### `Readonly`active[](#active)

active: boolean

#### Returns[](#returns)

The value indicating whether the story point is the currently active point in the story.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:57

### `Readonly`caption[](#caption)

caption: string

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

The content of the textual description for this story point.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:52

### `Readonly`containedSheet[](#containedsheet)

containedSheet: undefined | [Sheet](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Sheet.html)

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

The [Sheet](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Sheet.html) that this story point contains. This will be undefined if the story point does not have a contained sheet.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:67

### `Readonly`index[](#index)

index: number

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

The zero-based index of this story point within the parent [Story](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Story.html).

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:47

### `Readonly`parentStory[](#parentstory)

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

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

The [Story](https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/Story.html) object that contains this story point.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:72

### `Readonly`updated[](#updated)

updated: boolean

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

A boolean value indicating whether the story point is updated. If the value is false that means there are no changes from the last time the story point was “captured”.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/StoryInterfaces.ts:62

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[active](#active)[caption](#caption)[containedSheet](#containedsheet)[index](#index)[parentStory](#parentstory)[updated](#updated)