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