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>>