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