Visual class
Power BI Görseli ekleme bileşeni
- Extends
Devralınan Özellikler
bookmarks |
Yöntemler
get |
Filtre düzeyine uygulanan filtreleri alır. Varsayılan filtre düzeyi görsel düzeyidir.
|
get |
Rapordaki sayfaların listesini alır- görselde desteklenmez |
get |
Görsel adını, türünü vb. içeren eklenmiş görsel tanımlayıcı nesnesini alır.
|
remove |
Geçerli filtre düzeyindeki tüm filtreleri kaldırır. Varsayılan filtre düzeyi görsel düzeyidir.
|
set |
Filtreleri filtre düzeyinde ayarlar. Varsayılan filtre düzeyi görsel düzeyidir.
|
set |
Raporun etkin sayfasını ayarlar; görselde desteklenmez |
update |
Filtreleri filtre düzeyinde güncelleştirir. Varsayılan filtre düzeyi görsel düzeyidir.
|
Devralınan Yöntemler
add |
Bağlam menüsü uzantısı ekle komutu.
|
add |
Seçenekler menüsü uzantısı komutu ekle'yi seçin.
|
add |
Rapora boş sayfa ekleme
|
apply |
Rapora tema uygulama
|
are |
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.
|
clear |
Seçilen açılır olmayan görselleri temizler, bayrak geçirilirse tüm görsel seçimleri temizlenir.
|
close |
Tüm açık bağlam menülerini ve araç ipuçlarını kapatır.
|
config |
Yapılandırma değişikliklerini işleme. |
delete |
Rapordan sayfa silme
|
exit |
Tarayıcıdan tam ekran modundan çıkmasını istemektedir. |
fullscreen() | Tarayıcıdan bileşenin iframe'ini tam ekran modunda işlemesini istemektedir. |
get |
Etkin rapor sayfasını alır.
|
get |
Geçerli ekleme oturumu için correlationId değerini alın.
|
get |
Kullanılabilir ilk konumdan rapor kimliğini alır: seçenekler, öznitelik, ekleme URL'si. |
get |
Adına göre bir rapor sayfası alır.
|
get |
raporun temasını alma
|
get |
Raporun geçerli yakınlaştırma düzeyini döndürür. |
is |
raporun kaydedilip kaydedilmediğini denetler.
|
move |
Sayfadaki görselin konumunu güncelleştirir.
|
off<T>(string, IEvent |
İş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.
|
on<T>(string, IEvent |
Belirli bir olay için olay işleyicisi ekler.
|
print() | Ekleme iframe bileşeninde |
refresh() | Raporun veri kaynaklarını yeniler.
|
reload() | 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.
|
remove |
Öğenin tabindex özniteliğini kaldırır |
remove |
Bağlam menüsü uzantısını kaldır komutu.
|
remove |
Seçenekler menüsü uzantısını kaldır komutu.
|
rename |
Rapordan sayfayı yeniden adlandırma
|
reset |
Kullanıcının filtrelerini, dilimleyicilerini ve diğer veri görünümü değişikliklerini raporun varsayılan durumuna sıfırlama
|
reset |
Raporun varsayılan temasını sıfırlama ve uygulama
|
resize |
Rapordaki etkin sayfanın boyutunu güncelleştirir.
|
resize |
Sayfadaki görseli yeniden boyutlandırma.
|
save() | Raporu kaydeder. |
save |
KayıtAs Raporu. |
save |
Raporun kullanıcı filtrelerini, dilimleyicilerini ve diğer veri görünümü değişikliklerini kaydetme
|
set |
accessToken'i ayarlayın. |
set |
Öğenin tabindex özniteliğini ayarlar |
set |
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. |
set |
Sayfadaki görselin görüntüleme durumunu güncelleştirir.
|
set |
Raporun yakınlaştırma düzeyini ayarlar. |
switch |
Rapor düzenini güncelleştirir
|
switch |
Rapor görünümü modunu değiştirme. |
update |
Filtre bölmesi ve sayfa gezinti bölmesi için görünürlük ayarlarını güncelleştirir.
|
Devralınan Özellik Detayları
bookmarksManager
Yöntem Ayrıntıları
getFilters(FiltersLevel)
Filtre düzeyine uygulanan filtreleri alır. Varsayılan filtre düzeyi görsel düzeyidir.
visual.getFilters(filtersLevel)
.then(filters => {
...
});
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>
Parametreler
- filtersLevel
- FiltersLevel
Döndürülenler
Promise<IFilter[]>
getPages()
Rapordaki sayfaların listesini alır- görselde desteklenmez
function getPages(): Promise<Page[]>
Döndürülenler
Promise<Page[]>
getVisualDescriptor()
Görsel adını, türünü vb. içeren eklenmiş görsel tanımlayıcı nesnesini alır.
visual.getVisualDescriptor()
.then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>
Döndürülenler
Promise<VisualDescriptor>
removeFilters(FiltersLevel)
Geçerli filtre düzeyindeki tüm filtreleri kaldırır. Varsayılan filtre düzeyi görsel düzeyidir.
visual.removeFilters(filtersLevel);
function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parametreler
- filtersLevel
- FiltersLevel
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
setFilters(IFilter[], FiltersLevel)
Filtreleri filtre düzeyinde ayarlar. Varsayılan filtre düzeyi görsel düzeyidir.
const filters: [
...
];
visual.setFilters(filters, filtersLevel)
.catch(errors => {
...
});
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parametreler
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
setPage(string)
Raporun etkin sayfasını ayarlar; görselde desteklenmez
function setPage(_pageName: string): Promise<IHttpPostMessageResponse<void>>
Parametreler
- _pageName
-
string
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
updateFilters(FiltersOperations, IFilter[], FiltersLevel)
Filtreleri filtre düzeyinde güncelleştirir. Varsayılan filtre düzeyi görsel düzeyidir.
const filters: [
...
];
visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
.catch(errors => {
...
});
function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parametreler
- operation
- FiltersOperations
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
Devralınan Yöntemin Ayrıntıları
addContextMenuCommand(string, string, string, MenuLocation, string, string, string)
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
- commandName
-
string
- commandTitle
-
string
- contextMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)
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
- commandName
-
string
- commandTitle
-
string
- optionsMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
- commandIcon
-
string
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
addPage(string)
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
- displayName
-
string
Döndürülenler
Promise<Page>
applyTheme(IReportTheme)
Rapora tema uygulama
report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>
Parametreler
- theme
- IReportTheme
Döndürülenler
Promise<void>
arePersistentFiltersApplied()
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
Promise<boolean>
clearSelectedVisuals(boolean)
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
- clearPopOutState
-
boolean
Görsellerden biri açılır durumdaysa yanlış /tanımsız görsel seçimi temizlenmezse (odakta tablo olarak göster, öne çıkanlar...)
Döndürülenler
Promise<void>
closeAllOverlays()
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
Promise<void>
Report.closeAllOverlays Devralındı
configChanged(boolean)
Yapılandırma değişikliklerini işleme.
function configChanged(isBootstrap: boolean)
Parametreler
- isBootstrap
-
boolean
deletePage(string)
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
- pageName
-
string
Döndürülenler
Promise<void>
exitFullscreen()
Tarayıcıdan tam ekran modundan çıkmasını istemektedir.
function exitFullscreen()
fullscreen()
Tarayıcıdan bileşenin iframe'ini tam ekran modunda işlemesini istemektedir.
function fullscreen()
getActivePage()
Etkin rapor sayfasını alır.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
Döndürülenler
Promise<Page>
getCorrelationId()
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
Promise<string>
getId()
Kullanılabilir ilk konumdan rapor kimliğini alır: seçenekler, öznitelik, ekleme URL'si.
function getId(): string
Döndürülenler
string
getPageByName(string)
Adına göre bir rapor sayfası alır.
report.getPageByName(pageName)
.then(page => {
...
});
function getPageByName(pageName: string): Promise<Page>
Parametreler
- pageName
-
string
Döndürülenler
Promise<Page>
getTheme()
raporun temasını alma
report.getTheme();
function getTheme(): Promise<IReportTheme>
Döndürülenler
Promise<IReportTheme>
getZoom()
Raporun geçerli yakınlaştırma düzeyini döndürür.
function getZoom(): Promise<number>
Döndürülenler
Promise<number>
isSaved()
raporun kaydedilip kaydedilmediğini denetler.
report.isSaved()
function isSaved(): Promise<boolean>
Döndürülenler
Promise<boolean>
moveVisual(string, string, number, number, number)
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
- pageName
-
string
- visualName
-
string
- x
-
number
- y
-
number
- z
-
number
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
off<T>(string, IEventHandler<T>)
İş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
- eventName
-
string
- handler
-
IEventHandler<T>
on<T>(string, IEventHandler<T>)
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
- eventName
-
string
- handler
-
IEventHandler<T>
print()
Ekleme iframe bileşeninde window.print()
çağırarak raporun etkin sayfasını yazdırır.
function print(): Promise<void>
Döndürülenler
Promise<void>
refresh()
Raporun veri kaynaklarını yeniler.
report.refresh();
function refresh(): Promise<void>
Döndürülenler
Promise<void>
Report.refresh Devralındı
reload()
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
Promise<void>
removeComponentTabIndex(number)
Öğenin tabindex özniteliğini kaldırır
function removeComponentTabIndex(_tabIndex?: number)
Parametreler
- _tabIndex
-
number
removeContextMenuCommand(string, string)
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
- commandName
-
string
- contextMenuTitle
-
string
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
removeOptionsMenuCommand(string, string)
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
- commandName
-
string
- optionsMenuTitle
-
string
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
renamePage(string, string)
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
- pageName
-
string
- displayName
-
string
Döndürülenler
Promise<void>
resetPersistentFilters()
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
Promise<IHttpPostMessageResponse<void>>
resetTheme()
Raporun varsayılan temasını sıfırlama ve uygulama
report.resetTheme();
function resetTheme(): Promise<void>
Döndürülenler
Promise<void>
DevralındıReport.resetTheme
resizeActivePage(PageSizeType, number, number)
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
- pageSizeType
- PageSizeType
- width
-
number
- height
-
number
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
resizeVisual(string, string, number, number)
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
- pageName
-
string
- visualName
-
string
- width
-
number
- height
-
number
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
save()
Raporu kaydeder.
function save(): Promise<void>
Döndürülenler
Promise<void>
saveAs(ISaveAsParameters)
KayıtAs Raporu.
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
Parametreler
- saveAsParameters
- ISaveAsParameters
Döndürülenler
Promise<void>
savePersistentFilters()
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
Promise<IHttpPostMessageResponse<void>>
setAccessToken(string)
accessToken'i ayarlayın.
function setAccessToken(accessToken: string): Promise<void>
Parametreler
- accessToken
-
string
Döndürülenler
Promise<void>
setComponentTabIndex(number)
Öğenin tabindex özniteliğini ayarlar
function setComponentTabIndex(tabIndex?: number)
Parametreler
- tabIndex
-
number
setComponentTitle(string)
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
- title
-
string
Report.setComponentTitle Devralındı
setVisualDisplayState(string, string, VisualContainerDisplayMode)
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
- pageName
-
string
- visualName
-
string
- displayState
- VisualContainerDisplayMode
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
Report.setVisualDisplayState Devralındı
setZoom(number)
Raporun yakınlaştırma düzeyini ayarlar.
function setZoom(zoomLevel: number): Promise<void>
Parametreler
- zoomLevel
-
number
ayar için yakınlaştırma düzeyi
Döndürülenler
Promise<void>
switchLayout(LayoutType)
Rapor düzenini güncelleştirir
report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>
Parametreler
- layoutType
- LayoutType
Döndürülenler
Promise<IHttpPostMessageResponse<void>>
Report.switchLayout Devralındı
switchMode(string | ViewMode)
Rapor görünümü modunu değiştirme.
function switchMode(viewMode: string | ViewMode): Promise<void>
Parametreler
- viewMode
-
string | ViewMode
Döndürülenler
Promise<void>
Report.switchMode Devralındı
updateSettings(ISettings)
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
- settings
- ISettings
Döndürülenler
Promise<IHttpPostMessageResponse<void>>