Поделиться через

BookmarksManager class

  • Ссылка
Пакет:
powerbi-client

Управляет закладками отчетов.

Методы

apply(string)

Применение закладки по имени.

bookmarksManager.apply(bookmarkName)
applyState(string)

Применить состояние закладки.

bookmarksManager.applyState(bookmarkState)
capture(ICaptureBookmarkOptions)

Запись закладки из текущего состояния.

bookmarksManager.capture(options)
getBookmarks()

Возвращает закладки, определенные в отчете.

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

Воспроизведение закладок: ввод или выход из режима презентации закладок.

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

Сведения о методе

apply(string)

Применение закладки по имени.

bookmarksManager.apply(bookmarkName)

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

Параметры

bookmarkName

string

Имя применяемой закладки

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

applyState(string)

Применить состояние закладки.

bookmarksManager.applyState(bookmarkState)

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

Параметры

state

string

Примененное состояние закладки Base64

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

capture(ICaptureBookmarkOptions)

Запись закладки из текущего состояния.

bookmarksManager.capture(options)

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

Параметры

options
ICaptureBookmarkOptions

Параметры записи закладок

Возвращаемое значение

Promise<IReportBookmark>

getBookmarks()

Возвращает закладки, определенные в отчете.

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

function getBookmarks(): Promise<IReportBookmark[]>

Возвращаемое значение

Promise<IReportBookmark[]>

play(BookmarksPlayMode)

Воспроизведение закладок: ввод или выход из режима презентации закладок.

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

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

Параметры

playMode
BookmarksPlayMode

Режим воспроизведения может быть Presentation или Off

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>