BookmarksManager class

  • Referência
Pacote:
powerbi-client

Gerencia indicadores de relatório.

Métodos

apply(string)

Aplique o indicador pelo nome.

bookmarksManager.apply(bookmarkName)
applyState(string)

Aplicar o estado do indicador.

bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)

Capturar indicador do estado atual.

bookmarksManager.capture(options)
getBookmarks()

Obtém indicadores definidos no relatório.

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

Reproduzir indicadores: insira ou saia do modo de apresentação de indicadores.

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

Detalhes do método

apply(string)

Aplique o indicador pelo nome.

bookmarksManager.apply(bookmarkName)

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

Parâmetros

bookmarkName

string

O nome do indicador a ser aplicado

Retornos

Promise<IHttpPostMessageResponse<void>>

applyState(string)

Aplicar o estado do indicador.

bookmarksManager.applyState(bookmarkState)

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

Parâmetros

state

string

Um estado de indicador base64 a ser aplicado

Retornos

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

Capturar indicador do estado atual.

bookmarksManager.capture(options)

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

Parâmetros

options
ICaptureBookmarkOptions

Opções para captura de indicador

Retornos

Promise<IReportBookmark>

getBookmarks()

Obtém indicadores definidos no relatório.

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

function getBookmarks(): Promise<IReportBookmark[]>

Retornos

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

Reproduzir indicadores: insira ou saia do modo de apresentação de indicadores.

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

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

Parâmetros

playMode
BookmarksPlayMode

O modo de reprodução pode ser Presentation ou Off

Retornos

Promise<IHttpPostMessageResponse<void>>