---
schema_version: "1"
id: 2705d2f8cf1e2a92be1a6b932d3742122705325e2b7bd8e959b83911acd6d7cf
title: StoryPointInfo | 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/StoryPointInfo.md
canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/StoryPointInfo.html
source_site: help.tableau.com
content_type: documentation
content_hash: 6481d2f5bd5ebc8ab4e4f03e6c3f81fd7a26d8f152d5d6c909793f6eb85b60b3
description: Documentation for Tableau Embedding API
---
- StoryPointInfo

# Interface StoryPointInfo

interface StoryPointInfo {  
    [active](#active): boolean;  
    [caption](#caption): string;  
    [index](#index): number;  
    [parentStory](#parentstory): [Story](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Story.html);  
    [updated](#updated): boolean;  
}

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

##### Index

### Properties

[active](#active) [caption](#caption) [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:89

### `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:84

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

index: number

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

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

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

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

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

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

The [Story](https://help.tableau.com/v0.0/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:99

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

updated: boolean

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

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:94

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

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