Sdílet prostřednictvím

BookmarksManager class

  • Reference
Balíček:
powerbi-client

Spravuje záložky sestavy.

Metody

apply(string)

Použít záložku podle názvu

bookmarksManager.apply(bookmarkName)
applyState(string)

Použít stav záložky

bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)

Zachyťte záložku z aktuálního stavu.

bookmarksManager.capture(options)
getBookmarks()

Získá záložky, které jsou definovány v sestavě.

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

Přehrání záložek: Vstup nebo ukončení režimu prezentace záložek

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

Podrobnosti metody

apply(string)

Použít záložku podle názvu

bookmarksManager.apply(bookmarkName)

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

Parametry

bookmarkName

string

Název záložky, která se má použít

Návraty

Promise<IHttpPostMessageResponse<void>>

applyState(string)

Použít stav záložky

bookmarksManager.applyState(bookmarkState)

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

Parametry

state

string

Stav záložky base64, který se má použít

Návraty

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

Zachyťte záložku z aktuálního stavu.

bookmarksManager.capture(options)

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

Parametry

options
ICaptureBookmarkOptions

Možnosti zachytávání záložek

Návraty

Promise<IReportBookmark>

getBookmarks()

Získá záložky, které jsou definovány v sestavě.

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

function getBookmarks(): Promise<IReportBookmark[]>

Návraty

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

Přehrání záložek: Vstup nebo ukončení režimu prezentace záložek

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

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

Parametry

playMode
BookmarksPlayMode

Režim přehrávání může být Presentation nebo Off

Návraty

Promise<IHttpPostMessageResponse<void>>