Report class

bookmarksManager: BookmarksManager

Nilai Properti

Tambahkan perintah ekstensi menu konteks.

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

Parameter

Mengembalikan

Tambahkan perintah ekstensi menu opsi.

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

Parameter

Mengembalikan

Menambahkan halaman kosong ke laporan

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

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

Parameter

Mengembalikan

Menerapkan tema ke laporan

report.applyTheme(theme);

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

Parameter

Mengembalikan

Mengembalikan jika ada filter, pemotong, atau perubahan tampilan data lain pengguna yang diterapkan pada laporan. Jika filter persisten dinonaktifkan, mengembalikan false.

report.arePersistentFiltersApplied();

function arePersistentFiltersApplied(): Promise<boolean>

Mengembalikan

Menghapus visual yang dipilih tidak muncul, jika bendera diteruskan, semua pilihan visual akan dihapus.

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

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

Parameter

Mengembalikan

Menutup semua menu konteks dan tipsalat terbuka.

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

function closeAllOverlays(): Promise<void>

Mengembalikan

Menangani perubahan konfigurasi.

function configChanged(isBootstrap: boolean)

Parameter

Menghapus halaman dari laporan

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

Parameter

Mengembalikan

Mendapatkan halaman laporan aktif.

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

function getActivePage(): Promise<Page>

Mengembalikan

Mendapatkan filter yang diterapkan di tingkat laporan.

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

function getFilters(): Promise<IFilter[]>

Mengembalikan

Mendapatkan ID laporan dari lokasi pertama yang tersedia: opsi, atribut, url semat.

function getId(): string

Mengembalikan

Mendapatkan halaman laporan berdasarkan namanya.

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

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

Parameter

Mengembalikan

Mendapatkan daftar halaman dalam laporan.

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

function getPages(): Promise<Page[]>

Mengembalikan

mendapatkan tema laporan

report.getTheme();

function getTheme(): Promise<IReportTheme>

Mengembalikan

Mengembalikan tingkat pembesaran tampilan laporan saat ini.

function getZoom(): Promise<number>

Mengembalikan

memeriksa apakah laporan disimpan.

report.isSaved()

function isSaved(): Promise<boolean>

Mengembalikan

Memperbarui posisi visual di halaman.

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

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

Parameter

Mengembalikan

Mencetak halaman aktif laporan dengan memanggil window.print() pada komponen iframe yang disematkan.

function print(): Promise<void>

Mengembalikan

Menyegarkan sumber data untuk laporan.

report.refresh();

function refresh(): Promise<void>

Mengembalikan

Hapus perintah ekstensi menu konteks.

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

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

Parameter

Mengembalikan

Menghapus semua filter di tingkat laporan.

report.removeFilters();

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

Mengembalikan

Hapus perintah ekstensi menu opsi.

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

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

Parameter

Mengembalikan

Mengganti nama halaman dari laporan

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

Parameter

Mengembalikan

Merender laporan yang telah dimuat sebelumnya, menggunakan API penyematan bertahap

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

...

// Render report
report.render()

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

Parameter

Mengembalikan

Mereset filter, pemotong, dan perubahan tampilan data lainnya ke status default laporan

report.resetPersistentFilters();

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

Mengembalikan

Mereset dan menerapkan tema default laporan

report.resetTheme();

function resetTheme(): Promise<void>

Mengembalikan

Memperbarui ukuran halaman aktif dalam laporan.

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

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

Parameter

Mengembalikan

Mengubah ukuran visual di halaman.

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

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

Parameter

Mengembalikan

Menyimpan filter pengguna, pemotong, dan perubahan tampilan data lainnya dari laporan

report.savePersistentFilters();

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

Mengembalikan

Mengatur filter di tingkat laporan.

const filters: [
   ...
];

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

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

Parameter

Mengembalikan

Mengatur halaman aktif laporan.

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

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

Parameter

Mengembalikan

Memperbarui status tampilan visual di halaman.

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

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

Parameter

Mengembalikan

Mengatur tingkat pembesaran tampilan laporan.

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

Parameter

Mengembalikan

Memperbarui tata letak laporan

report.switchLayout(layoutType);

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

Parameter

Mengembalikan

Beralih mode tampilan Laporan.

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

Parameter

Mengembalikan

Perbarui filter di tingkat laporan sesuai dengan operasi: Tambahkan, ganti semua, ganti menurut target atau hapus.

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

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

Parameter

Mengembalikan

Memperbarui pengaturan visibilitas untuk panel filter dan panel navigasi halaman.

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

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

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

Parameter

Mengembalikan

Meminta browser untuk keluar dari mode layar penuh.

function exitFullscreen()

Diwariskan Dari Embed.exitFullscreen

Meminta browser untuk merender iframe komponen dalam mode layar penuh.

function fullscreen()

Diwariskan Dari layar Embed.fullscreen

Dapatkan correlationId untuk sesi semat saat ini.

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

function getCorrelationId(): Promise<string>

Mengembalikan

Diwariskan Dari Embed.getCorrelationId

Menghapus satu atau beberapa penanganan aktivitas dari daftar handler. Jika referensi ke fungsi handle yang ada ditentukan, hapus handler tertentu. Jika handler tidak ditentukan, hapus semua handler untuk nama peristiwa yang ditentukan.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parameter

Diwariskan Dari Embed.off

Menambahkan penanganan aktivitas untuk peristiwa tertentu.

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

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

Parameter

Diwariskan Dari Embed.on

Muat ulang disematkan menggunakan konfigurasi yang ada. Misalnya untuk laporan ini secara efektif menghapus semua filter dan membuat halaman pertama aktif yang mensimulasikan mengatur ulang laporan kembali ke status dimuat.

report.reload();

function reload(): Promise<void>

Mengembalikan

Diwariskan Dari Embed.reload

Menghapus atribut tabindex elemen

function removeComponentTabIndex(_tabIndex?: number)

Parameter

Diwariskan Dari Embed.removeComponentTabIndex

Menyimpan Laporan.

function save(): Promise<void>

Mengembalikan

Diwariskan Dari Embed.save

Laporan SaveAs.

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

Parameter

Mengembalikan

Diwariskan Dari Embed.saveAs

Atur accessToken.

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

Parameter

Mengembalikan

Diwariskan Dari Embed.setAccessToken

Mengatur atribut tabindex elemen

function setComponentTabIndex(tabIndex?: number)

Parameter

Diwarisi Dari Embed.setComponentTabIndex

Atur judul komponen untuk aksesibilitas. Dalam kasus iframe, metode ini akan mengubah judul iframe.

function setComponentTitle(title: string)

Parameter

Diwariskan Dari Embed.setComponentTitle