BookmarksManager class
Verwaltet Berichtsmarken.
Methoden
apply(string) | Lesezeichen nach Name anwenden.
|
apply |
Lesezeichenstatus anwenden.
|
capture(ICapture |
Lesezeichen aus dem aktuellen Zustand erfassen.
|
get |
Ruft Lesezeichen ab, die im Bericht definiert sind.
|
play(Bookmarks |
Lesezeichen wiedergeben: Öffnen oder Beenden sie den Präsentationsmodus für Lesezeichen.
|
Details zur Methode
apply(string)
Lesezeichen nach Name anwenden.
bookmarksManager.apply(bookmarkName)
function apply(bookmarkName: string): Promise<IHttpPostMessageResponse<void>>
Parameter
- bookmarkName
-
string
Der Name des Lesezeichens, das angewendet werden soll
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
applyState(string)
Lesezeichenstatus anwenden.
bookmarksManager.applyState(bookmarkState)
function applyState(state: string): Promise<IHttpPostMessageResponse<void>>
Parameter
- state
-
string
Ein base64-Lesezeichenstatus, der angewendet werden soll
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
capture(ICaptureBookmarkOptions)
Lesezeichen aus dem aktuellen Zustand erfassen.
bookmarksManager.capture(options)
function capture(options?: ICaptureBookmarkOptions): Promise<IReportBookmark>
Parameter
- options
- ICaptureBookmarkOptions
Optionen für die Lesezeichenerfassung
Gibt zurück
Promise<IReportBookmark>
getBookmarks()
Ruft Lesezeichen ab, die im Bericht definiert sind.
// Gets bookmarks that are defined in the report
bookmarksManager.getBookmarks()
.then(bookmarks => {
...
});
function getBookmarks(): Promise<IReportBookmark[]>
Gibt zurück
Promise<IReportBookmark[]>
play(BookmarksPlayMode)
Lesezeichen wiedergeben: Öffnen oder Beenden sie den Präsentationsmodus für Lesezeichen.
// Enter presentation mode.
bookmarksManager.play(BookmarksPlayMode.Presentation)
function play(playMode: BookmarksPlayMode): Promise<IHttpPostMessageResponse<void>>
Parameter
- playMode
- BookmarksPlayMode
Der Wiedergabemodus kann entweder Presentation
oder sein. Off
Gibt zurück
Promise<IHttpPostMessageResponse<void>>