Report class

bookmarksManager: BookmarksManager

Özellik Değeri

Bağlam menüsü uzantısı ekle komutu.

report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName)
 .catch(error => {
     ...
 });

function addContextMenuCommand(commandName: string, commandTitle: string, contextMenuTitle: string, menuLocation: MenuLocation, visualName: string, visualType: string, groupName?: string): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Seçenekler menüsü uzantısı komutu ekle'yi seçin.

report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon)
 .catch(error => {
     ...
 });

function addOptionsMenuCommand(commandName: string, commandTitle: string, optionsMenuTitle?: string, menuLocation?: MenuLocation, visualName?: string, visualType?: string, groupName?: string, commandIcon?: string): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Rapora boş sayfa ekleme

// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");

function addPage(displayName?: string): Promise<Page>

Parametreler

Döndürülenler

Rapora tema uygulama

report.applyTheme(theme);

function applyTheme(theme: IReportTheme): Promise<void>

Parametreler

Döndürülenler

Rapora kullanıcı filtreleri, dilimleyicileri veya başka veri görünümü değişiklikleri uygulanmışsa döndürür. Kalıcı filtreler devre dışı bırakılırsa false döndürür.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Döndürülenler

Seçilen açılır olmayan görselleri temizler, bayrak geçirilirse tüm görsel seçimleri temizlenir.

report.clearSelectedVisuals()
 .then(() => {
     ...
 });

function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>

Parametreler

Döndürülenler

Tüm açık bağlam menülerini ve araç ipuçlarını kapatır.

report.closeAllOverlays()
 .then(() => {
     ...
 });

function closeAllOverlays(): Promise<void>

Döndürülenler

Yapılandırma değişikliklerini işleme.

function configChanged(isBootstrap: boolean)

Parametreler

Rapordan sayfa silme

// Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API)
report.deletePage("ReportSection145");

function deletePage(pageName: string): Promise<void>

Parametreler

Döndürülenler

Etkin rapor sayfasını alır.

report.getActivePage()
 .then(activePage => {
     ...
 });

function getActivePage(): Promise<Page>

Döndürülenler

Rapor düzeyinde uygulanan filtreleri alır.

// Get filters applied at report level
report.getFilters()
  .then(filters => {
    ...
  });

function getFilters(): Promise<IFilter[]>

Döndürülenler

Kullanılabilir ilk konumdan rapor kimliğini alır: seçenekler, öznitelik, ekleme URL'si.

function getId(): string

Döndürülenler

Adına göre bir rapor sayfası alır.

report.getPageByName(pageName)
 .then(page => {
     ...
 });

function getPageByName(pageName: string): Promise<Page>

Parametreler

Döndürülenler

Rapordaki sayfaların listesini alır.

report.getPages()
 .then(pages => {
     ...
 });

function getPages(): Promise<Page[]>

Döndürülenler

raporun temasını alma

report.getTheme();

function getTheme(): Promise<IReportTheme>

Döndürülenler

Raporun geçerli yakınlaştırma düzeyini döndürür.

function getZoom(): Promise<number>

Döndürülenler

raporun kaydedilip kaydedilmediğini denetler.

report.isSaved()

function isSaved(): Promise<boolean>

Döndürülenler

Sayfadaki görselin konumunu güncelleştirir.

report.moveVisual(pageName, visualName, x, y, z)
  .catch(error => { ... });

function moveVisual(pageName: string, visualName: string, x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Ekleme iframe bileşeninde window.print() çağırarak raporun etkin sayfasını yazdırır.

function print(): Promise<void>

Döndürülenler

Raporun veri kaynaklarını yeniler.

report.refresh();

function refresh(): Promise<void>

Döndürülenler

Bağlam menüsü uzantısını kaldır komutu.

report.removeContextMenuCommand(commandName, contextMenuTitle)
 .catch(error => {
     ...
 });

function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Rapor düzeyindeki tüm filtreleri kaldırır.

report.removeFilters();

function removeFilters(): Promise<IHttpPostMessageResponse<void>>

Döndürülenler

Seçenekler menüsü uzantısını kaldır komutu.

report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
 .then({
     ...
 });

function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Rapordan sayfayı yeniden adlandırma

// Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API)
report.renamePage("ReportSection145", "Sales");

function renamePage(pageName: string, displayName: string): Promise<void>

Parametreler

Döndürülenler

Aşamalı ekleme API'sini kullanarak önceden yüklenmiş bir raporu işleme

// Load report
var report = powerbi.load(element, config);

...

// Render report
report.render()

function render(config?: IReportEmbedConfiguration | IReportLoadConfiguration): Promise<void>

Parametreler

Döndürülenler

Kullanıcının filtrelerini, dilimleyicilerini ve diğer veri görünümü değişikliklerini raporun varsayılan durumuna sıfırlama

report.resetPersistentFilters();

function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>

Döndürülenler

Raporun varsayılan temasını sıfırlama ve uygulama

report.resetTheme();

function resetTheme(): Promise<void>

Döndürülenler

Rapordaki etkin sayfanın boyutunu güncelleştirir.

report.resizeActivePage(pageSizeType, width, height)
  .catch(error => { ... });

function resizeActivePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Sayfadaki görseli yeniden boyutlandırma.

report.resizeVisual(pageName, visualName, width, height)
  .catch(error => { ... });

function resizeVisual(pageName: string, visualName: string, width: number, height: number): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Raporun kullanıcı filtrelerini, dilimleyicilerini ve diğer veri görünümü değişikliklerini kaydetme

report.savePersistentFilters();

function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>

Döndürülenler

Filtreleri rapor düzeyinde ayarlar.

const filters: [
   ...
];

report.setFilters(filters)
 .catch(errors => {
   ...
 });

function setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Raporun etkin sayfasını ayarlar.

report.setPage("page2")
 .catch(error => { ... });

function setPage(pageName: string): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Sayfadaki görselin görüntüleme durumunu güncelleştirir.

report.setVisualDisplayState(pageName, visualName, displayState)
  .catch(error => { ... });

function setVisualDisplayState(pageName: string, visualName: string, displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Raporun yakınlaştırma düzeyini ayarlar.

function setZoom(zoomLevel: number): Promise<void>

Parametreler

Döndürülenler

Rapor düzenini güncelleştirir

report.switchLayout(layoutType);

function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Rapor görünümü modunu değiştirme.

function switchMode(viewMode: string | ViewMode): Promise<void>

Parametreler

Döndürülenler

Rapor düzeyindeki filtreleri şu işleme göre güncelleştirin: Tümünü ekleyin, değiştirin, hedefe göre değiştirin veya kaldırın.

report.updateFilters(FiltersOperations.Add, filters)
  .catch(errors => { ... });

function updateFilters(operation: FiltersOperations, filters?: IFilter[]): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Filtre bölmesi ve sayfa gezinti bölmesi için görünürlük ayarlarını güncelleştirir.

const newSettings = {
  panes: {
    filters: {
      visible: false
    }
  }
};

report.updateSettings(newSettings)
  .catch(error => { ... });

function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>

Parametreler

Döndürülenler

Tarayıcıdan tam ekran modundan çıkmasını istemektedir.

function exitFullscreen()

Embed.exitFullscreen Devralındı

Tarayıcıdan bileşenin iframe'ini tam ekran modunda işlemesini istemektedir.

function fullscreen()

Embed.fullscreen'den Devralınan

Geçerli ekleme oturumu için correlationId değerini alın.

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });

function getCorrelationId(): Promise<string>

Döndürülenler

Embed.getCorrelationId Devralındı

İşleyici listesinden bir veya daha fazla olay işleyicisini kaldırır. Mevcut tanıtıcı işlevine bir başvuru belirtilirse, belirli işleyiciyi kaldırın. İşleyici belirtilmezse, belirtilen olay adı için tüm işleyicileri kaldırın.

report.off('pageChanged')

or

const logHandler = function (event) {
   console.log(event);
};

report.off('pageChanged', logHandler);

function off<T>(eventName: string, handler?: IEventHandler<T>)

Parametreler

Embed.off'tan Devralındı

Belirli bir olay için olay işleyicisi ekler.

report.on('pageChanged', (event) => {
  console.log('PageChanged: ', event.page.name);
});

function on<T>(eventName: string, handler: IEventHandler<T>)

Parametreler

Embed.on'dan Devralınmış

Mevcut yapılandırmayı kullanarak eklemeyi yeniden yükler. Örneğin, raporlar için bu, tüm filtreleri etkili bir şekilde temizler ve bir raporun yeniden yüklenmiş duruma sıfırlanması benzetimini yapan ilk sayfayı etkin hale getirir.

report.reload();

function reload(): Promise<void>

Döndürülenler

Embed.reload'dan Devralınmış

Öğenin tabindex özniteliğini kaldırır

function removeComponentTabIndex(_tabIndex?: number)

Parametreler

Embed.removeComponentTabIndex Devralındı

Raporu kaydeder.

function save(): Promise<void>

Döndürülenler

Embed.save'ten Devralınmış

KayıtAs Raporu.

function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>

Parametreler

Döndürülenler

Embed.saveAs'tan Devralınmış

accessToken'i ayarlayın.

function setAccessToken(accessToken: string): Promise<void>

Parametreler

Döndürülenler

Embed.setAccessToken'dan Devralınmış

Öğenin tabindex özniteliğini ayarlar

function setComponentTabIndex(tabIndex?: number)

Parametreler

Embed.setComponentTabIndex'ten Devralınmış

Erişilebilirlik için bileşen başlığını ayarlayın. iframe'ler söz konusu olduğunda, bu yöntem iframe başlığını değiştirir.

function setComponentTitle(title: string)

Parametreler

Embed.setComponentTitle Devralındı