BookmarksManager class

Package:

powerbi-client

Manages report bookmarks.

Methods

apply(string)	Apply bookmark by name. bookmarksManager.apply(bookmarkName)
applyState(string)	Apply bookmark state. bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)	Capture bookmark from current state. bookmarksManager.capture(options)
getBookmarks()	Gets bookmarks that are defined in the report. // Gets bookmarks that are defined in the report bookmarksManager.getBookmarks() .then(bookmarks => { ... });
play(BookmarksPlayMode)	Play bookmarks: Enter or Exit bookmarks presentation mode. // Enter presentation mode. bookmarksManager.play(BookmarksPlayMode.Presentation)

Method Details

apply(string)

Apply bookmark by name.

bookmarksManager.apply(bookmarkName)

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

Parameters

bookmarkName

string

The name of the bookmark to be applied

Returns

Promise<IHttpPostMessageResponse<void>>

applyState(string)

Apply bookmark state.

bookmarksManager.applyState(bookmarkState)

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

Parameters

state

string

A base64 bookmark state to be applied

Returns

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

Capture bookmark from current state.

bookmarksManager.capture(options)

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

Parameters

options

ICaptureBookmarkOptions

Options for bookmark capturing

Returns

Promise<IReportBookmark>

getBookmarks()

Gets bookmarks that are defined in the report.

// Gets bookmarks that are defined in the report
bookmarksManager.getBookmarks()
  .then(bookmarks => {
    ...
  });

function getBookmarks(): Promise<IReportBookmark[]>

Returns

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

Play bookmarks: Enter or Exit bookmarks presentation mode.

// Enter presentation mode.
bookmarksManager.play(BookmarksPlayMode.Presentation)

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

Parameters

playMode

BookmarksPlayMode

Play mode can be either Presentation or Off

Returns

Promise<IHttpPostMessageResponse<void>>