IBookmarksManager interface

APIs for managing the report bookmarks.

Methods

apply(string)
applyState(string)
capture(ICaptureBookmarkOptions)
getBookmarks()
play(BookmarksPlayMode)

Method Details

apply(string)

function apply(bookmarkName: string): Promise<IHttpPostMessageResponse<void>>

Parameters

bookmarkName

string

Returns

Promise<IHttpPostMessageResponse<void>>

applyState(string)

function applyState(state: string): Promise<IHttpPostMessageResponse<void>>

Parameters

state

string

Returns

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

function capture(options?: ICaptureBookmarkOptions): Promise<IReportBookmark>

Parameters

Returns

Promise<IReportBookmark>

getBookmarks()

function getBookmarks(): Promise<IReportBookmark[]>

Returns

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

function play(playMode: BookmarksPlayMode): Promise<IHttpPostMessageResponse<void>>

Parameters

Returns

Promise<IHttpPostMessageResponse<void>>