Yer işaretleri ile kullanıcılarınızın deneyimini geliştirme
Power BI'daki rapor yer işaretleri, tüm filtreler ve görsellerinin durumu da dahil olmak üzere eklenmiş rapor sayfasının geçerli durumunu yakalamanıza olanak sağlar. Raporu daha sonra açtığınızda, raporu kaydedilmiş duruma geri yüklemek için yer işaretini seçebilirsiniz. Geliştiriciler, yer işaretlerini yakalamak ve uygulamak için Power BI İstemci API'lerini kullanarak kullanıcı deneyimini denetleyebiliyor.
Kaydedilen yer işareti, bir raporun parçası olarak kaydedilmiş bir yer işareti veya raporun gerçek zamanlı durumu olarak yakalanan bir yer işareti olabilir. Rapor yüklerken kaydedilmiş bir yer işareti uygularsanız, yer işaretinin adını veya durumunu sağlayarak kullanılacak yer işaretini belirtebilirsiniz. Ada göre bir yer işareti sağlarsanız raporunuzun aynı ada sahip kaydedilmiş bir yer işareti içermesi gerekir.
Bu makalede yer işaretlerini destekleyen raporları eklemek için ihtiyacınız olan farklı API ayarları açıklanmaktadır.
Not
Kuruluşunuz için eklediğiniz raporlarda rapor tüketicileri raporun durumunu yakalayarak kişisel yer işaretleri oluşturur ve yer işaretini seçerek hızla bu duruma döner. Daha fazla bilgi için bkz . Kişisel yer işaretleri .
Müşterileriniz için eklediğiniz raporlarda benzer bir deneyim oluşturma hakkında bilgi için Bkz. Power BI tümleşik analiz oyun alanında rapor görünümü gösterimini yakalama.
Power BI'da yer işaretlerini kullanma hakkında daha fazla bilgi için bkz. Power BI Desktop'de yer işaretleri oluşturma.
Power BI'ı eklerken kişisel yer işaretlerini kullanma hakkında bilgi için bkz . Kişisel yer işaretleri.
Rapor yer işaretlerini kullanma
Aşağıdaki bölümlerde, rapor yer işaretleriyle çalışmak için Power BI İstemci API'lerinin nasıl kullanılacağı gösterilmektedir.
Raporun yer işaretlerini yönetme
Raporun yer işaretlerini yönetmek için eklenmiş rapor örneğinin özelliğini kullanınbookmarksManager
.
BookmarksManager sınıfı aşağıdaki yöntemlere sahiptir:
getBookmarks
- Raporla ilişkili kaydedilmiş yer işaretlerinin listesini döndürür.apply
- Rapora önceden kaydedilmiş bir yer işareti adına göre uygulanır.capture
- Raporun geçerli durumunu temsil eden base64 serileştirme dizesini yakalar ve döndürür.applyState
Bir yer işaretinin önceden yakalanan base64 serileştirme durumunu rapora uygular.play
- Raporun yer işaretleri için slayt gösterisi sunu modunu denetler.
Rapor yer işaretine erişme
Tek bir yer işaretine erişmek için yöntemini kullanarak getBookmarks
bir nesne listesine erişin ReportBookmark
.
sınıfı ReportBookmark
aşağıdaki özelliklere sahiptir:
name
- Rapor yer işaretinin benzersiz tanımlayıcısı.displayName
- Yer İşaretleri bölmesinde görünen rapor yer işaretinin görünen adı.state
- Rapor yer işaretinin durumunun base64 seri hale getirilmesi. Bunu kaydedebilir ve yöntemiyle bir raporabookmarksManager.applyState
uygulayabilirsiniz.children
- Varsa, rapor yer işareti grubunu temsil eden nesnelerin listesiReportBookmark
.
Rapor yer işaretleri API'lerini kullanma
Katıştırılmış bir raporda geliştiriciler şunları yapabilir:
- Kaydedilen rapor yer işaretlerinin listesini alın.
- Rapor yükünde veya oturum sırasında ada göre kaydedilmiş bir yer işareti uygulayın.
- Geçerli görünümü yakalayın ve yer işareti nesnesi olarak alın.
- Yakalanan yer işareti durumunu rapor yükünde veya oturum sırasında uygulama
- Rapor yer işareti uygulandığında ek mantık gerçekleştirme.
- Yer İşaretleri bölmesini gösterin veya gizleyin.
- Yer işaretleri slayt gösterisi moduna girin veya bu moddan çıkın.
Kaydedilen rapor yer işaretlerinin listesini alma
Raporla ilişkili kaydedilmiş yer işaretlerinin listesini almak için raporun özelliği tarafından döndürülen BookmarksManager nesnesinin yöntemini çağırın bookmarksManager
getBookmarks
.
getBookmarks
yöntemi aşağıdaki gibi tanımlanır:
getBookmarks(): Promise<models.IReportBookmark[]>
Örnek:
let bookmarks = await report.bookmarksManager.getBookmarks();
Kaydedilmiş yer işaretini rapor yükünde veya oturum sırasında ada göre uygulama
Daha önce kaydedilmiş bir yer işaretini yer işareti adını kullanarak rapora uygulamak için, raporun özelliği tarafından döndürülen BookmarksManager nesnesinin yöntemini çağırın bookmarksManager
apply
.
Daha fazla bilgi için bkz . Rapor ayarlarını yapılandırma.
apply
yöntemi aşağıdaki gibi tanımlanır:
apply(bookmarkName: string): Promise<void>
Örnek:
await report.bookmarksManager.apply("Bookmark1234");
Geçerli görünümü yer işareti nesnesi olarak yakalama ve alma
Raporun geçerli durumunu base64 dizesi olarak yakalamak için BookmarksManager nesnesinin yöntemini çağırıncapture
. capture
yöntemi, belirli bir IReportBookmark
rapora kaydedilmeyen bir yer işaretini temsil eden bir nesnesi döndürür. IReportBookmark.state
Özelliğini kullanarak yer işareti durumunu tanımlayan base64 dizesini döndürebilir ve bu dizeyi daha sonra yükleme süresi veya çalışma zamanı sırasında bir rapora uygulayabilirsiniz.
capture
yöntemi aşağıdaki gibi tanımlanır:
capture(options?:ICaptureBookmarkOptions): Promise<models.IReportBookmark>
Örnek:
let capturedBookmark = await report.bookmarksManager.capture();
Yer işareti yakalama seçenekleri
Bir nesneyi yöntemine capture
de geçirebilirsinizICaptureBookmarkOptions
.
interface ICaptureBookmarkOptions {
allPages?: boolean;
personalizeVisuals?: boolean;
}
allPages
- Varsayılan olarak, yakalanan yer işareti durumu yalnızca geçerli sayfa durumunu kaydeder. Tüm sayfaların durumunu yakalamak için seçeneği olarak ayarlanmıştrue
yönteminiallPages
çağırıncapture
.personalizeVisuals
- Kişiselleştirilmiş görsellerle geçerli durumu yakalamak için seçeneği olarak ayarlanmıştrue
yöntemini çağırıncapture
personalizeVisuals
.
Örneğin, aşağıdaki kod kişiselleştirilmiş görseller de dahil olmak üzere tüm sayfaların durumunu yakalar:
let capturedBookmark = await report.bookmarksManager.capture({
allPages: true,
personalizeVisuals: true
});
Yakalanan yer işareti durumunu rapor yükünde veya oturum sırasında uygulama
Daha önce yakalanan yer işareti durumunu bir rapora uygulamak için BookmarksManager nesnesinin yöntemini kullanınapplyState
.
Daha fazla bilgi için bkz . Rapor ayarlarını yapılandırma.
applyState
yöntemi aşağıdaki gibi tanımlanır:
applyState(state: string): Promise<void>
Örnek:
await report.bookmarksManager.applyState(capturedBookmark.state);
Rapor yer işareti uygulandığında ek mantık gerçekleştirme
Bir rapor yer işaretinin ne zaman uygulandığını belirlemek için, rapor nesnesinin bookmarkApplied
on
yöntemini çağırarak olayı dinleyin.
Örnek:
report.on("bookmarkApplied", (event) => {
console.log(event.detail.name);
});
Yer İşaretleri bölmesini gösterme veya gizleme
Power BI Yer İşaretleri bölmesini göstermek veya gizlemek için rapor ayarlarının özelliğini güncelleştirin panes
.
Yer İşaretleri bölmesini gösterme
let embedConfig = {
...
panes: {
bookmarks: {
visible: true
}
}
};
Yer İşaretleri bölmesini gizleme
let embedConfig = {
...
panes: {
bookmarks: {
visible: false
}
}
};
Rapor ayarlarını güncelleştirme hakkında bilgi için bkz. Rapor ayarlarını yapılandırma.
Yer işaretlerine girme veya slayt gösterisi modundan çıkma
Raporun yer işaretlerinin slayt gösterisi sunu modunu denetlemek için BookmarksManager nesnesinin yöntemini çağırınplay
. Daha fazla bilgi için bkz . Slayt gösterisi olarak yer işaretleri.
play
yöntemi aşağıdaki gibi tanımlanır:
play(playMode: models.BookmarksPlayMode): Promise<void>
Not
Yer işaretleri slayt gösterisi moduna girmeden önce raporda getBookmarks API'sine sahip en az bir yer işareti olduğundan emin olun.
Slayt gösterisi sunu moduna girme
await report.bookmarksManager.play(models.BookmarksPlayMode.Presentation);
Slayt gösterisi sunu modundan çıkma
await report.bookmarksManager.play(models.BookmarksPlayMode.Off);
Sınırlamalar
Yer işaretleri API'sini kullandığınızda raporda yapılan bazı değişiklikler hataya veya beklenmeyen bir sonuca neden olabilir. Bunun bir örneği, rapor filtrelerini rapordan kaldırmaktır. Hataları önlemek için ilgili filtre kartlarının mevcut olması gerekir. Filtreleri kaldırmak yerine değerlerini olarak
All
ayarlayın. Hangi filtrelerin silindiğini veya değiştirildiğini bilmiyorsanız, değişiklikleri rapora uyguladıktan sonra yer işaretini yeniden özetleyin.Ekleme oturumu tarafından oluşturulan veya güncelleştirme filtreleri ekleme işlemi tarafından eklenen yük filtreleri gibi filtreler yer işareti durumunda yakalanır, ancak yalnızca geçerli oturumda uygulanır. Bu sınırlamayı aşmak için filtre değerle
All
rapora kaydedilmeli ve güncelleştirme filtreleri güncelleştirme işlemi kullanılarak ekleme oturumunda değiştirilmelidir.