BookmarksManager class

包:

powerbi-client

管理报表书签。

方法

apply(string)	按名称应用书签。 bookmarksManager.apply(bookmarkName)
applyState(string)	应用书签状态。 bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)	从当前状态捕获书签。 bookmarksManager.capture(options)
getBookmarks()	获取报表中定义的书签。 // Gets bookmarks that are defined in the report bookmarksManager.getBookmarks() .then(bookmarks => { ... });
play(BookmarksPlayMode)	播放书签：进入或退出书签演示模式。 // Enter presentation mode. bookmarksManager.play(BookmarksPlayMode.Presentation)

方法详细信息

apply(string)

按名称应用书签。

bookmarksManager.apply(bookmarkName)

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

参数

bookmarkName

string

要应用的书签的名称

返回

Promise<IHttpPostMessageResponse<void>>

applyState(string)

应用书签状态。

bookmarksManager.applyState(bookmarkState)

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

参数

state

string

要应用的 base64 书签状态

返回

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

从当前状态捕获书签。

bookmarksManager.capture(options)

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

参数

options

ICaptureBookmarkOptions

书签捕获的选项

返回

Promise<IReportBookmark>

getBookmarks()

获取报表中定义的书签。

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

function getBookmarks(): Promise<IReportBookmark[]>

返回

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

播放书签：进入或退出书签演示模式。

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

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

参数

playMode

BookmarksPlayMode

播放模式可以是 Presentation 或 Off

返回

Promise<IHttpPostMessageResponse<void>>