Visual class
Komponen Power BI Visual embed
- Memperluas
Properti yang Diwariskan
| bookmarks |
Metode
| get |
Mendapatkan filter yang diterapkan ke tingkat filter. Tingkat filter default adalah tingkat visual.
|
| get |
Mendapatkan daftar halaman dalam laporan - tidak didukung di visual |
| get |
Mendapatkan objek deskriptor visual yang disematkan yang berisi nama visual, jenis, dll.
|
| remove |
Menghapus semua filter dari tingkat filter saat ini. Tingkat filter default adalah tingkat visual.
|
| set |
Mengatur filter pada tingkat filter. Tingkat filter default adalah tingkat visual.
|
| set |
Mengatur halaman aktif laporan - tidak didukung di visual |
| update |
Memperbarui filter di tingkat filter. Tingkat filter default adalah tingkat visual.
|
Metode yang Diwarisi
| add |
Tambahkan perintah ekstensi menu konteks.
|
| add |
Tambahkan perintah ekstensi menu opsi.
|
| add |
Menambahkan halaman kosong ke laporan
|
| apply |
Menerapkan tema ke laporan
|
| are |
Mengembalikan jika ada filter, pemotong, atau perubahan tampilan data lain pengguna yang diterapkan pada laporan. Jika filter persisten dinonaktifkan, mengembalikan false.
|
| clear |
Menghapus visual yang dipilih tidak muncul, jika bendera diteruskan, semua pilihan visual akan dihapus.
|
| close |
Menutup semua menu konteks dan tipsalat terbuka.
|
| config |
Menangani perubahan konfigurasi. |
| delete |
Menghapus halaman dari laporan
|
| exit |
Meminta browser untuk keluar dari mode layar penuh. |
| fullscreen() | Meminta browser untuk merender iframe komponen dalam mode layar penuh. |
| get |
Mendapatkan halaman laporan aktif.
|
| get |
Dapatkan correlationId untuk sesi semat saat ini.
|
| get |
Mendapatkan ID laporan dari lokasi pertama yang tersedia: opsi, atribut, url semat. |
| get |
Mendapatkan halaman laporan berdasarkan namanya.
|
| get |
mendapatkan tema laporan
|
| get |
Mengembalikan tingkat pembesaran tampilan laporan saat ini. |
| is |
memeriksa apakah laporan disimpan.
|
| move |
Memperbarui posisi visual di halaman.
|
| off<T>(string, IEvent |
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.
|
| on<T>(string, IEvent |
Menambahkan penanganan aktivitas untuk peristiwa tertentu.
|
| print() | Mencetak halaman aktif laporan dengan memanggil |
| refresh() | Menyegarkan sumber data untuk laporan.
|
| reload() | 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.
|
| remove |
Menghapus atribut tabindex elemen |
| remove |
Hapus perintah ekstensi menu konteks.
|
| remove |
Hapus perintah ekstensi menu opsi.
|
| rename |
Mengganti nama halaman dari laporan
|
| reset |
Mereset filter, pemotong, dan perubahan tampilan data lainnya ke status default laporan
|
| reset |
Mereset dan menerapkan tema default laporan
|
| resize |
Memperbarui ukuran halaman aktif dalam laporan.
|
| resize |
Mengubah ukuran visual di halaman.
|
| save() | Menyimpan Laporan. |
| save |
Laporan SaveAs. |
| save |
Menyimpan filter pengguna, pemotong, dan perubahan tampilan data lainnya dari laporan
|
| set |
Atur accessToken. |
| set |
Mengatur atribut tabindex elemen |
| set |
Atur judul komponen untuk aksesibilitas. Dalam kasus iframe, metode ini akan mengubah judul iframe. |
| set |
Memperbarui status tampilan visual di halaman.
|
| set |
Mengatur tingkat pembesaran tampilan laporan. |
| switch |
Memperbarui tata letak laporan
|
| switch |
Beralih mode tampilan Laporan. |
| update |
Memperbarui pengaturan visibilitas untuk panel filter dan panel navigasi halaman.
|
Detail Properti yang Diwariskan
bookmarksManager
bookmarksManager: BookmarksManager
Nilai Properti
Detail Metode
getFilters(FiltersLevel)
Mendapatkan filter yang diterapkan ke tingkat filter. Tingkat filter default adalah tingkat visual.
visual.getFilters(filtersLevel)
.then(filters => {
...
});
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>
Parameter
- filtersLevel
- FiltersLevel
Mengembalikan
Promise<IFilter[]>
getPages()
Mendapatkan daftar halaman dalam laporan - tidak didukung di visual
function getPages(): Promise<Page[]>
Mengembalikan
Promise<Page[]>
getVisualDescriptor()
Mendapatkan objek deskriptor visual yang disematkan yang berisi nama visual, jenis, dll.
visual.getVisualDescriptor()
.then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>
Mengembalikan
Promise<VisualDescriptor>
removeFilters(FiltersLevel)
Menghapus semua filter dari tingkat filter saat ini. Tingkat filter default adalah tingkat visual.
visual.removeFilters(filtersLevel);
function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parameter
- filtersLevel
- FiltersLevel
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
setFilters(IFilter[], FiltersLevel)
Mengatur filter pada tingkat filter. Tingkat filter default adalah tingkat visual.
const filters: [
...
];
visual.setFilters(filters, filtersLevel)
.catch(errors => {
...
});
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parameter
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
setPage(string)
Mengatur halaman aktif laporan - tidak didukung di visual
function setPage(_pageName: string): Promise<IHttpPostMessageResponse<void>>
Parameter
- _pageName
-
string
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
updateFilters(FiltersOperations, IFilter[], FiltersLevel)
Memperbarui filter di tingkat filter. Tingkat filter default adalah tingkat visual.
const filters: [
...
];
visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
.catch(errors => {
...
});
function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parameter
- operation
- FiltersOperations
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Detail Metode yang Diwarisi
addContextMenuCommand(string, string, string, MenuLocation, string, string, string)
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
- commandName
-
string
- commandTitle
-
string
- contextMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Diwariskan DariReport.addContextMenuCommand
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)
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
- commandName
-
string
- commandTitle
-
string
- optionsMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
- commandIcon
-
string
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Diwarisi DariReport.addOptionsMenuCommand
addPage(string)
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
- displayName
-
string
Mengembalikan
Promise<Page>
applyTheme(IReportTheme)
Menerapkan tema ke laporan
report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>
Parameter
- theme
- IReportTheme
Mengembalikan
Promise<void>
Diwariskan DariReport.applyTheme
arePersistentFiltersApplied()
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
Promise<boolean>
Diwariskan DariReport.arePersistentFiltersApplied
clearSelectedVisuals(boolean)
Menghapus visual yang dipilih tidak muncul, jika bendera diteruskan, semua pilihan visual akan dihapus.
report.clearSelectedVisuals()
.then(() => {
...
});
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>
Parameter
- clearPopOutState
-
boolean
Jika pemilihan visual false/undefined tidak akan dihapus jika salah satu visual dalam status muncul (dalam fokus, tampilkan sebagai tabel, sorotan...)
Mengembalikan
Promise<void>
Diwariskan DariReport.clearSelectedVisuals
closeAllOverlays()
Menutup semua menu konteks dan tipsalat terbuka.
report.closeAllOverlays()
.then(() => {
...
});
function closeAllOverlays(): Promise<void>
Mengembalikan
Promise<void>
Diwariskan DariReport.closeAllOverlays
configChanged(boolean)
Menangani perubahan konfigurasi.
function configChanged(isBootstrap: boolean)
Parameter
- isBootstrap
-
boolean
Diwarisi DariReport.configChanged
deletePage(string)
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
- pageName
-
string
Mengembalikan
Promise<void>
Diwariskan DariReport.deletePage
exitFullscreen()
Meminta browser untuk keluar dari mode layar penuh.
function exitFullscreen()
fullscreen()
Meminta browser untuk merender iframe komponen dalam mode layar penuh.
function fullscreen()
getActivePage()
Mendapatkan halaman laporan aktif.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
Mengembalikan
Promise<Page>
Diwariskan DariReport.getActivePage
getCorrelationId()
Dapatkan correlationId untuk sesi semat saat ini.
// Get the correlationId for the current embed session
report.getCorrelationId()
.then(correlationId => {
...
});
function getCorrelationId(): Promise<string>
Mengembalikan
Promise<string>
getId()
Mendapatkan ID laporan dari lokasi pertama yang tersedia: opsi, atribut, url semat.
function getId(): string
Mengembalikan
string
getPageByName(string)
Mendapatkan halaman laporan berdasarkan namanya.
report.getPageByName(pageName)
.then(page => {
...
});
function getPageByName(pageName: string): Promise<Page>
Parameter
- pageName
-
string
Mengembalikan
Promise<Page>
getTheme()
mendapatkan tema laporan
report.getTheme();
function getTheme(): Promise<IReportTheme>
Mengembalikan
Promise<IReportTheme>
Diwariskan DariReport.getTheme
getZoom()
Mengembalikan tingkat pembesaran tampilan laporan saat ini.
function getZoom(): Promise<number>
Mengembalikan
Promise<number>
Diwarisi DariReport.getZoom
isSaved()
memeriksa apakah laporan disimpan.
report.isSaved()
function isSaved(): Promise<boolean>
Mengembalikan
Promise<boolean>
Diwarisi DariReport.isSaved
moveVisual(string, string, number, number, number)
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
- pageName
-
string
- visualName
-
string
- x
-
number
- y
-
number
- z
-
number
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Diwariskan DariReport.moveVisual
off<T>(string, IEventHandler<T>)
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
- eventName
-
string
- handler
-
IEventHandler<T>
on<T>(string, IEventHandler<T>)
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
- eventName
-
string
- handler
-
IEventHandler<T>
print()
Mencetak halaman aktif laporan dengan memanggil window.print() pada komponen iframe yang disematkan.
function print(): Promise<void>
Mengembalikan
Promise<void>
refresh()
Menyegarkan sumber data untuk laporan.
report.refresh();
function refresh(): Promise<void>
Mengembalikan
Promise<void>
reload()
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
Promise<void>
removeComponentTabIndex(number)
Menghapus atribut tabindex elemen
function removeComponentTabIndex(_tabIndex?: number)
Parameter
- _tabIndex
-
number
Diwarisi DariReport.removeComponentTabIndex
removeContextMenuCommand(string, string)
Hapus perintah ekstensi menu konteks.
report.removeContextMenuCommand(commandName, contextMenuTitle)
.catch(error => {
...
});
function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Parameter
- commandName
-
string
- contextMenuTitle
-
string
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Diwariskan DariReport.removeContextMenuCommand
removeOptionsMenuCommand(string, string)
Hapus perintah ekstensi menu opsi.
report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
.then({
...
});
function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Parameter
- commandName
-
string
- optionsMenuTitle
-
string
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Diwariskan DariReport.removeOptionsMenuCommand
renamePage(string, string)
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
- pageName
-
string
- displayName
-
string
Mengembalikan
Promise<void>
Diwarisi DariReport.renamePage
resetPersistentFilters()
Mereset filter, pemotong, dan perubahan tampilan data lainnya ke status default laporan
report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
resetTheme()
Mereset dan menerapkan tema default laporan
report.resetTheme();
function resetTheme(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi DariReport.resetTheme
resizeActivePage(PageSizeType, number, number)
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
- pageSizeType
- PageSizeType
- width
-
number
- height
-
number
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Diwariskan DariReport.resizeActivePage
resizeVisual(string, string, number, number)
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
- pageName
-
string
- visualName
-
string
- width
-
number
- height
-
number
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Diwariskan DariReport.resizeVisual
save()
Menyimpan Laporan.
function save(): Promise<void>
Mengembalikan
Promise<void>
saveAs(ISaveAsParameters)
Laporan SaveAs.
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
Parameter
- saveAsParameters
- ISaveAsParameters
Mengembalikan
Promise<void>
savePersistentFilters()
Menyimpan filter pengguna, pemotong, dan perubahan tampilan data lainnya dari laporan
report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Diwarisi DariReport.savePersistentFilters
setAccessToken(string)
Atur accessToken.
function setAccessToken(accessToken: string): Promise<void>
Parameter
- accessToken
-
string
Mengembalikan
Promise<void>
setComponentTabIndex(number)
Mengatur atribut tabindex elemen
function setComponentTabIndex(tabIndex?: number)
Parameter
- tabIndex
-
number
Diwarisi DariReport.setComponentTabIndex
setComponentTitle(string)
Atur judul komponen untuk aksesibilitas. Dalam kasus iframe, metode ini akan mengubah judul iframe.
function setComponentTitle(title: string)
Parameter
- title
-
string
setVisualDisplayState(string, string, VisualContainerDisplayMode)
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
- pageName
-
string
- visualName
-
string
- displayState
- VisualContainerDisplayMode
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
Diwariskan DariReport.setVisualDisplayState
setZoom(number)
Mengatur tingkat pembesaran tampilan laporan.
function setZoom(zoomLevel: number): Promise<void>
Parameter
- zoomLevel
-
number
tingkat perbesar tampilan untuk diatur
Mengembalikan
Promise<void>
switchLayout(LayoutType)
Memperbarui tata letak laporan
report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>
Parameter
- layoutType
- LayoutType
Mengembalikan
Promise<IHttpPostMessageResponse<void>>
switchMode(string | ViewMode)
Beralih mode tampilan Laporan.
function switchMode(viewMode: string | ViewMode): Promise<void>
Parameter
- viewMode
-
string | ViewMode
Mengembalikan
Promise<void>
updateSettings(ISettings)
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
- settings
- ISettings
Mengembalikan
Promise<IHttpPostMessageResponse<void>>