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)
- Sheet
- Story
Methods
activateNextStoryPointAsync
Returns Promise<StoryPoint>
A promise that resolves to the active StoryPoint.
activatePreviousStoryPointAsync
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.
activateStoryPointAsync
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.
changeSizeAsync
revertStoryPointAsync
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.
Activates the next story point if there is one. If the current story point is the last one, then it stays active.