Udostępnij za pośrednictwem

BookmarksManager class

  • Odwołanie
Pakiet:
powerbi-client

Zarządza zakładkami raportów.

Metody

apply(string)

Zastosuj zakładkę według nazwy.

bookmarksManager.apply(bookmarkName)
applyState(string)

Zastosuj stan zakładki.

bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)

Przechwyć zakładkę z bieżącego stanu.

bookmarksManager.capture(options)
getBookmarks()

Pobiera zakładki zdefiniowane w raporcie.

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

Odtwórz zakładki: wprowadź lub Zakończ tryb prezentacji zakładek.

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

Szczegóły metody

apply(string)

Zastosuj zakładkę według nazwy.

bookmarksManager.apply(bookmarkName)

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

Parametry

bookmarkName

string

Nazwa zakładki do zastosowania

Zwraca

Promise<IHttpPostMessageResponse<void>>

applyState(string)

Zastosuj stan zakładki.

bookmarksManager.applyState(bookmarkState)

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

Parametry

state

string

Stan zakładki base64 do zastosowania

Zwraca

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

Przechwyć zakładkę z bieżącego stanu.

bookmarksManager.capture(options)

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

Parametry

options
ICaptureBookmarkOptions

Opcje przechwytywania zakładek

Zwraca

Promise<IReportBookmark>

getBookmarks()

Pobiera zakładki zdefiniowane w raporcie.

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

function getBookmarks(): Promise<IReportBookmark[]>

Zwraca

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

Odtwórz zakładki: wprowadź lub Zakończ tryb prezentacji zakładek.

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

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

Parametry

playMode
BookmarksPlayMode

Tryb odtwarzania może być Presentation lub Off

Zwraca

Promise<IHttpPostMessageResponse<void>>