Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Story

Hierarchy

Index

Properties

Methods

Properties

activeStoryPoint

activeStoryPoint: StoryPoint
returns

The currently active story point.

index

index: number
returns

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.

isActive

isActive: boolean
returns

A value indicating whether the sheet is the currently active sheet.

isHidden

isHidden: boolean
returns

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.

name

name: string
returns

The name of the sheet.

sheetType

sheetType: SheetType
returns

The type of the sheet.

size

size: SheetSize
returns

The size information that the author specified when publishing the workbook.

storyPointsInfo

storyPointsInfo: Array<StoryPointInfo>
returns

An array of StoryPointInfo objects.

url

url: string
returns

the URL for this sheet.

workbook

workbook: Workbook
returns

The workbook containing this sheet

Methods

activateNextStoryPointAsync

  • activateNextStoryPointAsync(): Promise<StoryPoint>

  • 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>

    A promise that resolves to the active StoryPoint.

activatePreviousStoryPointAsync

  • activatePreviousStoryPointAsync(): Promise<StoryPoint>

  • 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

  • activateStoryPointAsync(index: number): Promise<StoryPoint>

  • 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

  • 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

    Returns Promise<SheetSize>

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.