StoryPoint | Tableau Embedding API

Interface StoryPoint

interface StoryPoint {
    active: boolean;
    caption: string;
    containedSheet: undefined | Sheet;
    index: number;
    parentStory: Story;
    updated: boolean;
}
Index

Properties

active: boolean

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

caption: string

The content of the textual description for this story point.

containedSheet: undefined | Sheet

The Sheet that this story point contains. This will be undefined if the story point does not have a contained sheet.

index: number

The zero-based index of this story point within the parent Story.

parentStory: Story

The Story object that contains this story point.

updated: boolean

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”.