Partager via

BookmarksManager class

  • Référence
Paquet:
powerbi-client

Gère les signets de rapport.

Méthodes

apply(string)

Appliquez un signet par nom.

bookmarksManager.apply(bookmarkName)
applyState(string)

Appliquez l’état du signet.

bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)

Capturez le signet à partir de l’état actuel.

bookmarksManager.capture(options)
getBookmarks()

Obtient les signets définis dans le rapport.

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

Lire les signets : mode de présentation Entrée ou Quitter les signets.

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

Détails de la méthode

apply(string)

Appliquez un signet par nom.

bookmarksManager.apply(bookmarkName)

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

Paramètres

bookmarkName

string

Nom du signet à appliquer

Retours

Promise<IHttpPostMessageResponse<void>>

applyState(string)

Appliquez l’état du signet.

bookmarksManager.applyState(bookmarkState)

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

Paramètres

state

string

État de signet base64 à appliquer

Retours

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

Capturez le signet à partir de l’état actuel.

bookmarksManager.capture(options)

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

Paramètres

options
ICaptureBookmarkOptions

Options de capture de signets

Retours

Promise<IReportBookmark>

getBookmarks()

Obtient les signets définis dans le rapport.

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

function getBookmarks(): Promise<IReportBookmark[]>

Retours

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

Lire les signets : mode de présentation Entrée ou Quitter les signets.

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

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

Paramètres

playMode
BookmarksPlayMode

Le mode lecture peut être Presentation ou Off

Retours

Promise<IHttpPostMessageResponse<void>>