Class BookmarksManager

Manages report bookmarks.

export
class: BookmarksManager
implements: {IBookmarksManager}

Hierarchy

BookmarksManager

Implements

IBookmarksManager

Index

Properties

Methods

Properties

Private config

config: IEmbedConfigurationBase

Private Optional iframe

iframe: HTMLIFrameElement

Private service

service: Service

Methods

apply

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

Implementation of IBookmarksManager.apply
- Defined in src/bookmarksManager.ts:81
Apply bookmark by name.
```
bookmarksManager.apply(bookmarkName)
```
Parameters
- bookmarkName: string
  
  The name of the bookmark to be applied
Returns Promise<IHttpPostMessageResponse<void>>

applyState

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

Implementation of IBookmarksManager.applyState
- Defined in src/bookmarksManager.ts:161
Apply bookmark state.
```
bookmarksManager.applyState(bookmarkState)
```
Parameters
- state: string
  
  A base64 bookmark state to be applied
Returns Promise<IHttpPostMessageResponse<void>>

capture

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

Implementation of IBookmarksManager.capture
- Defined in src/bookmarksManager.ts:134
Capture bookmark from current state.
```
bookmarksManager.capture(options)
```
Parameters
- Optional options: ICaptureBookmarkOptions
Returns Promise<IReportBookmark>

getBookmarks

getBookmarks(): Promise<IReportBookmark[]>

Implementation of IBookmarksManager.getBookmarks
- Defined in src/bookmarksManager.ts:58
Gets bookmarks that are defined in the report.
```
// Gets bookmarks that are defined in the report
bookmarksManager.getBookmarks()
  .then(bookmarks => {
    ...
  });
```
Returns Promise<IReportBookmark[]>

play

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

Implementation of IBookmarksManager.play
- Defined in src/bookmarksManager.ts:108
Play bookmarks: Enter or Exit bookmarks presentation mode.
```
// Enter presentation mode.
bookmarksManager.play(BookmarksPlayMode.Presentation)
```
Parameters
- playMode: BookmarksPlayMode
  
  Play mode can be either Presentation or Off
Returns Promise<IHttpPostMessageResponse<void>>

Generated using TypeDoc