Memfilter data saat runtime untuk dasbor dan visual yang QuickSight disematkan

Anda dapat menggunakan metode filter di QuickSight penyematan Amazon SDK untuk memanfaatkan kekuatan QuickSight filter dalam aplikasi perangkat lunak sebagai layanan (SaaS) Anda saat runtime. Filter runtime memungkinkan pemilik bisnis untuk mengintegrasikan aplikasi mereka dengan QuickSight dasbor dan visual yang disematkan. Untuk mencapai hal ini, buat kontrol filter khusus dalam aplikasi Anda dan terapkan preset filter berdasarkan data dari aplikasi Anda. Kemudian, pengembang dapat mempersonalisasi konfigurasi filter untuk pengguna akhir saat runtime.

Pengembang dapat membuat, meminta, memperbarui, dan menghapus filter pada dasbor tertanam atau visual dari aplikasi mereka dengan QuickSight EmbeddingSDK. Buat objek QuickSight filter dalam aplikasi Anda dengan model FilterGroupdata dan terapkan ke dasbor dan visual yang disematkan menggunakan metode filter. Untuk informasi selengkapnya tentang penggunaan QuickSight EmbeddingSDK, lihat amazon-quicksight-embedding-sdkpada GitHub.

Prasyarat

Sebelum Anda dapat memulai, pastikan Anda menggunakan QuickSight Embedding SDK versi 2.5.0 atau lebih tinggi.

Terminologi dan konsep

Terminologi berikut dapat berguna saat bekerja dengan penyaringan runtime tertanam.

• Grup filter — Sekelompok filter individual. Filter yang terletak di dalam a FilterGroup adalah OR-ed satu sama lain. Filter dalam a FilterGroupditerapkan pada lembar atau visual yang sama.

• Filter — Filter tunggal. Filter dapat berupa jenis filter kategori, numerik, atau datetime. Untuk informasi selengkapnya tentang filter, lihat Menyaring.

Pengaturan

Sebelum Anda mulai, pastikan Anda memiliki aset dan informasi berikut yang disiapkan.

• ID lembar lembar yang ingin Anda cakup FilterGroup ke. Ini dapat diperoleh dengan getSheets metode di Embedding. SDK

• Dataset dan pengidentifikasi kolom dari kumpulan data yang ingin Anda filter. Ini dapat diperoleh melalui DescribeDashboardDefinitionAPIoperasi.

  Bergantung pada jenis kolom yang Anda gunakan, mungkin ada batasan pada jenis filter yang dapat ditambahkan ke aset tertanam. Untuk informasi selengkapnya tentang pembatasan filter, lihat Memfilter.

• ID visual visual yang ingin Anda lingkup FilterGroup ke, jika berlaku. Ini dapat diperoleh dengan menggunakan getSheetVisuals metode di Embedding. SDK

  Selain getSheetVisuals metode, FilterGroup yang Anda tambahkan hanya dapat dicakup ke lembar yang saat ini dipilih.

Untuk menggunakan fitur ini, Anda harus sudah memiliki dasbor atau visual yang disematkan ke dalam aplikasi Anda melalui QuickSight EmbeddingSDK. Untuk informasi selengkapnya tentang penggunaan QuickSight PenyematanSDK, lihat [tautan salah di Quip].

SDKantarmuka metode

Metode pengambil penyematan dasbor

Tabel berikut menjelaskan metode pengambil penyematan dasbor yang berbeda yang dapat digunakan pengembang.

Metode	Deskripsi
getFilterGroupsForSheet(sheetId: string)	Mengembalikan semua FilterGroups yang saat ini dicakup ke lembar yang disediakan dalam parameter.
getFilterGroupsForVisual(sheetId: string, visualId: string)	Mengembalikan semua FilterGroups yang dicakup ke visual yang disediakan dalam parameter.

Jika lembar yang disediakan dalam parameter bukan lembar yang saat ini dipilih dari dasbor tertanam, metode di atas mengembalikan kesalahan.

Metode pengambil penyematan visual

Tabel berikut menjelaskan berbagai metode pengambil penyematan visual yang dapat digunakan pengembang.

Metode	Deskripsi
getFilterGroups()	Mengembalikan semua FilterGroups yang saat ini dicakup ke visual tertanam.

Metode setter

Tabel berikut menjelaskan metode setter berbeda yang dapat digunakan pengembang untuk dashboard atau penyematan visual.

Metode	Deskripsi
addFilterGroups(filterGroups: FilterGroup[])	Menambahkan dan menerapkan yang disediakan FilterGroupske dasbor tertanam atau visual. A ResponseMessage yang menunjukkan apakah penambahan berhasil dikembalikan.
updateFilterGroups(filterGroups: FilterGroup[])	Memperbarui pengalaman tertanam yang berisi FilterGroupId sama dengan FilterGroup yang disediakan dalam parameter. FilterGroups A ResponseMessage yang menunjukkan apakah pembaruan berhasil dikembalikan.
removeFilterGroups(filterGroupsOrIds: FilterGroup[] | string[])	Menghapus yang disediakan FilterGroups dari dasbor dan mengembalikan a ResponseMessage yang menunjukkan apakah upaya penghapusan berhasil.

FilterGroupYang disediakan harus dicakup ke lembar tertanam atau visual yang saat ini dipilih.