Freigeben über

BookmarksManager class

  • Referenz
Paket:
powerbi-client

Verwaltet Berichtsmarken.

Methoden

apply(string)

Textmarke nach Name anwenden.

bookmarksManager.apply(bookmarkName)
applyState(string)

Textmarkenstatus anwenden.

bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)

Erfassen Sie textmarken aus dem aktuellen Zustand.

bookmarksManager.capture(options)
getBookmarks()

Ruft Lesezeichen ab, die im Bericht definiert sind.

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

Textmarken wiedergeben: Präsentationsmodus "Textmarken eingeben oder beenden".

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

Details zur Methode

apply(string)

Textmarke nach Name anwenden.

bookmarksManager.apply(bookmarkName)

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

Parameter

bookmarkName

string

Der Name der zu anwendenden Textmarke

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

applyState(string)

Textmarkenstatus anwenden.

bookmarksManager.applyState(bookmarkState)

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

Parameter

state

string

Ein Base64-Textmarkenstatus, der angewendet werden soll

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

Erfassen Sie textmarken aus dem aktuellen Zustand.

bookmarksManager.capture(options)

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

Parameter

options
ICaptureBookmarkOptions

Optionen für die Textmarkenerfassung

Gibt zurück

Promise<IReportBookmark>

getBookmarks()

Ruft Lesezeichen ab, die im Bericht definiert sind.

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

function getBookmarks(): Promise<IReportBookmark[]>

Gibt zurück

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

Textmarken wiedergeben: Präsentationsmodus "Textmarken eingeben oder beenden".

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

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

Parameter

playMode
BookmarksPlayMode

Der Wiedergabemodus kann entweder Presentation oder Off

Gibt zurück

Promise<IHttpPostMessageResponse<void>>