Bagikan melalui

Tingkatkan pengalaman pengguna Anda dengan marka buku

  • Artikel

Laporkan marka buku di Power BI memungkinkan Anda mengambil status halaman laporan yang disematkan saat ini, termasuk semua filter dan status visualnya. Saat membuka laporan di lain waktu, Anda dapat memilih marka buku untuk memulihkan laporan ke status tersimpan. Pengembang dapat mengontrol pengalaman pengguna dengan menggunakan API Klien Power BI untuk mengambil dan menerapkan marka buku.

Marka buku yang disimpan dapat berupa marka buku yang disimpan sebagai bagian dari laporan atau marka buku yang ditangkap sebagai status laporan real-time. Jika Anda menerapkan bookmark yang disimpan saat memuat laporan, Anda dapat menentukan marka buku yang akan digunakan dengan memberikan nama marka buku atau statusnya. Jika Anda memberikan marka buku berdasarkan nama, laporan Anda harus berisi marka buku yang disimpan dengan nama yang sama.

Artikel ini menjelaskan berbagai pengaturan API yang anda perlukan untuk menyematkan laporan yang mendukung marka buku.

Nota

Dalam laporan, Anda menyematkan untuk organisasi Anda, laporkan konsumen membuat marka buku pribadi dengan menangkap status laporan, dan dengan cepat kembali ke status tersebut dengan memilih marka buku. Lihat bookmark pribadi untuk informasi selengkapnya.

Untuk informasi tentang cara membuat pengalaman serupa dalam laporan yang Anda sematkan untuk pelanggan Anda, lihat tampilan laporan pengambilan menampilkan di taman bermain analitik tersemat Power BI.

Untuk informasi selengkapnya tentang menggunakan bookmark di Power BI, lihat Membuat marka buku di Power BI Desktop.

Untuk informasi tentang menggunakan marka buku pribadi saat menyematkan Power BI, lihat Bookmark Pribadi.

Cara menggunakan marka buku laporan

Bagian berikut ini memperlihatkan cara menggunakan API Klien Power BI untuk bekerja dengan marka buku laporan.

Mengelola marka buku laporan

Untuk mengelola marka buku laporan, gunakan properti bookmarksManager instans laporan yang disematkan .

Kelas BookmarksManager memiliki metode berikut:

  • getBookmarks - Mengembalikan daftar marka buku tersimpan yang terkait dengan laporan.

  • apply - Berlaku berdasarkan nama bookmark yang disimpan sebelumnya ke laporan.

  • capture - Mengambil dan mengembalikan string serialisasi base64, yang mewakili status laporan saat ini.

  • applyState Menerapkan status serialisasi base64 yang diambil sebelumnya dari marka buku ke laporan.

  • play - Mengontrol mode presentasi peragaan slide untuk bookmark laporan.

Mengakses bookmark laporan

Untuk mengakses bookmark individual, gunakan metode getBookmarks untuk mengakses daftar objek ReportBookmark. Kelas ReportBookmark memiliki properti berikut:

  • name - Pengidentifikasi unik marka buku laporan.

  • - Nama tampilan marka buku laporan, yang muncul di panel Bookmark .

  • state - Serialisasi base64 dari status marka buku laporan. Anda dapat menyimpannya dan menerapkannya ke laporan dengan metode bookmarksManager.applyState.

  • children - Daftar objek ReportBookmark yang mewakili grup marka buku laporan, jika ada.

Menggunakan API marka buku laporan

Dalam laporan yang disematkan, pengembang dapat:

Mendapatkan daftar marka buku laporan yang disimpan

Untuk mendapatkan daftar marka buku tersimpan yang terkait dengan laporan, panggil metode getBookmarks objek BookmarksManager yang dikembalikan oleh properti bookmarksManager laporan.

Metode getBookmarks didefinisikan sebagai berikut:

getBookmarks(): Promise<models.IReportBookmark[]>

Misalnya:

let bookmarks = await report.bookmarksManager.getBookmarks();

Menerapkan bookmark yang disimpan berdasarkan nama pada beban laporan atau selama sesi

Untuk menerapkan bookmark yang disimpan sebelumnya ke laporan dengan menggunakan nama bookmark-nya, panggil metode apply objek BookmarksManager yang dikembalikan oleh properti bookmarksManager laporan.

Untuk informasi selengkapnya, lihat Mengonfigurasi pengaturan laporan.

Metode apply didefinisikan sebagai berikut:

apply(bookmarkName: string): Promise<void>

Misalnya:

await report.bookmarksManager.apply("Bookmark1234");

Mengambil dan mendapatkan tampilan saat ini sebagai objek bookmark

Untuk mengambil status laporan saat ini sebagai string base64, panggil metode capture objek BookmarksManager. Metode capture mengembalikan objek IReportBookmark, yang mewakili marka buku yang tidak disimpan dalam laporan tertentu. Gunakan properti IReportBookmark.state untuk mengembalikan string base64 yang mengidentifikasi status marka buku, yang nantinya dapat Anda terapkan ke laporan selama waktu pemuatan atau waktu proses.

Metode capture didefinisikan sebagai berikut:

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

Misalnya:

let capturedBookmark = await report.bookmarksManager.capture();

Mengambil opsi marka buku

Anda juga dapat meneruskan objek ICaptureBookmarkOptions ke metode capture.

interface ICaptureBookmarkOptions {
    allPages?: boolean;
    personalizeVisuals?: boolean;
}
  • allPages - Secara default, status marka buku yang diambil hanya akan menyimpan status halaman saat ini. Untuk mengambil status semua halaman, panggil metode capture dengan opsi allPages diatur ke true.
  • - Untuk menangkap status saat ini denganvisual yang dipersonalisasi , panggil metode dengan opsi diatur ke .

Misalnya, kode berikut mengambil status semua halaman, termasuk visual yang dipersonalisasi:

let capturedBookmark = await report.bookmarksManager.capture({
    allPages: true,
    personalizeVisuals: true
});

Menerapkan status marka buku yang diambil pada beban laporan atau selama sesi

Untuk menerapkan status bookmark yang diambil sebelumnya ke laporan, gunakan metode applyState objek BookmarksManager.

Untuk informasi selengkapnya, lihat Mengonfigurasi pengaturan laporan.

Metode applyState didefinisikan sebagai berikut:

applyState(state: string): Promise<void>

Misalnya:

await report.bookmarksManager.applyState(capturedBookmark.state);

Melakukan logika tambahan saat bookmark laporan diterapkan

Untuk menentukan kapan bookmark laporan telah diterapkan, dengarkan peristiwa dengan memanggil metode objek laporan .

Misalnya:

report.on("bookmarkApplied", (event) => {
    console.log(event.detail.name);
});

Perlihatkan atau sembunyikan panel Marka Buku

Untuk memperlihatkan atau menyembunyikan panel Bookmark Power BI, perbarui properti pengaturan laporan.

Perlihatkan panel Marka Buku

let embedConfig = {
    ...
    panes: {
        bookmarks: {
            visible: true
        }
    }
};

Sembunyikan panel Marka Buku

let embedConfig = {
    ...
    panes: {
        bookmarks: {
            visible: false
        }
    }
};

Untuk informasi tentang memperbarui pengaturan laporan, lihat Mengonfigurasi pengaturan laporan.

Masuk atau keluar dari mode peragaan slide marka buku

Untuk mengontrol mode presentasi peragaan slide untuk bookmark laporan, panggil metode objek BookmarksManager. Untuk informasi selengkapnya, lihat Bookmark sebagai peragaan slide.

Metode play didefinisikan sebagai berikut:

play(playMode: models.BookmarksPlayMode): Promise<void>

Nota

Sebelum memasukkan mode peragaan slide marka buku, pastikan setidaknya ada satu marka buku pada laporan dengan getBookmarks API.

Masukkan mode presentasi peragaan slide

await report.bookmarksManager.play(models.BookmarksPlayMode.Presentation);

Keluar dari mode presentasi peragaan slide

await report.bookmarksManager.play(models.BookmarksPlayMode.Off);

Pertimbangan dan batasan

  • Saat Anda menggunakan BOOKMARK API, perubahan tertentu pada laporan dapat menyebabkan kesalahan atau hasil yang tidak terduga. Salah satu contohnya adalah menghapus filter laporan dari laporan. Untuk menghindari kesalahan, kartu filter yang sesuai harus ada. Alih-alih menghapus filter, atur nilainya ke All. Jika Anda tidak tahu filter mana yang dihapus atau diubah, ambil kembali marka buku setelah Anda menerapkan perubahan pada laporan.

  • Filter seperti pada filter beban dibuat oleh sesi semat atau ditambahkan oleh filter pembaruan menambahkan operasi, diambil dalam status bookmark tetapi hanya akan diterapkan dalam sesi saat ini. Untuk mengatasi batasan ini, filter harus disimpan pada laporan dengan nilai All, dan dimodifikasi dalam sesi semat menggunakan operasi pembaruan filter pembaruan .

Konten terkait