Condividi tramite

BookmarksManager class

  • Riferimento
Pacchetto:
powerbi-client

Gestisce i segnalibri del report.

Metodi

apply(string)

Applicare il segnalibro in base al nome.

bookmarksManager.apply(bookmarkName)
applyState(string)

Applicare lo stato del segnalibro.

bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)

Acquisisci segnalibro dallo stato corrente.

bookmarksManager.capture(options)
getBookmarks()

Ottiene i segnalibri definiti nel report.

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

Riproduci segnalibri: immettere o uscire dalla modalità di presentazione segnalibri.

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

Dettagli metodo

apply(string)

Applicare il segnalibro in base al nome.

bookmarksManager.apply(bookmarkName)

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

Parametri

bookmarkName

string

Nome del segnalibro da applicare

Restituisce

Promise<IHttpPostMessageResponse<void>>

applyState(string)

Applicare lo stato del segnalibro.

bookmarksManager.applyState(bookmarkState)

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

Parametri

state

string

Stato segnalibro base64 da applicare

Restituisce

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

Acquisisci segnalibro dallo stato corrente.

bookmarksManager.capture(options)

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

Parametri

options
ICaptureBookmarkOptions

Opzioni per l'acquisizione di segnalibri

Restituisce

Promise<IReportBookmark>

getBookmarks()

Ottiene i segnalibri definiti nel report.

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

function getBookmarks(): Promise<IReportBookmark[]>

Restituisce

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

Riproduci segnalibri: immettere o uscire dalla modalità di presentazione segnalibri.

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

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

Parametri

playMode
BookmarksPlayMode

La modalità di riproduzione può essere Presentation o Off

Restituisce

Promise<IHttpPostMessageResponse<void>>