BookmarksManager class
レポート ブックマークを管理します。
メソッド
apply(string) | 名前でブックマークを適用します。
|
apply |
ブックマークの状態を適用します。
|
capture(ICapture |
現在の状態からブックマークをキャプチャします。
|
get |
レポートで定義されているブックマークを取得します。
|
play(Bookmarks |
ブックマークを再生する: ブックマークのプレゼンテーション モードを開始または終了します。
|
メソッドの詳細
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>>