Compartir a través de

BookmarksManager class

  • Referencia
Paquete:
powerbi-client

Administra los marcadores de informe.

Métodos

apply(string)

Aplicar marcador por nombre.

bookmarksManager.apply(bookmarkName)
applyState(string)

Aplicar el estado del marcador.

bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)

Capture el marcador del estado actual.

bookmarksManager.capture(options)
getBookmarks()

Obtiene marcadores definidos en el informe.

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

Reproducir marcadores: escriba o salga del modo de presentación de marcadores.

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

Detalles del método

apply(string)

Aplicar marcador por nombre.

bookmarksManager.apply(bookmarkName)

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

Parámetros

bookmarkName

string

Nombre del marcador que se va a aplicar

Devoluciones

Promise<IHttpPostMessageResponse<void>>

applyState(string)

Aplicar el estado del marcador.

bookmarksManager.applyState(bookmarkState)

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

Parámetros

state

string

Estado de marcador base64 que se va a aplicar

Devoluciones

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

Capture el marcador del estado actual.

bookmarksManager.capture(options)

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

Parámetros

options
ICaptureBookmarkOptions

Opciones para la captura de marcadores

Devoluciones

Promise<IReportBookmark>

getBookmarks()

Obtiene marcadores definidos en el informe.

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

function getBookmarks(): Promise<IReportBookmark[]>

Devoluciones

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

Reproducir marcadores: escriba o salga del modo de presentación de marcadores.

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

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

Parámetros

playMode
BookmarksPlayMode

El modo de reproducción puede ser Presentation o Off

Devoluciones

Promise<IHttpPostMessageResponse<void>>