Visual class
Komponenta Pro vložení vizuálu Power BI
- Extends
Zděděné vlastnosti
bookmarks |
Metody
get |
Získá filtry použité na úrovni filtru. Výchozí úroveň filtru je úroveň vizuálu.
|
get |
Získá seznam stránek v sestavě – není podporován ve vizuálu. |
get |
Získá vložený objekt popisovače vizuálu, který obsahuje název vizuálu, typ atd.
|
remove |
Odebere všechny filtry z aktuální úrovně filtru. Výchozí úroveň filtru je úroveň vizuálu.
|
set |
Nastaví filtry na úrovni filtru. Výchozí úroveň filtru je úroveň vizuálu.
|
set |
Nastaví aktivní stránku sestavy – není podporována ve vizuálu. |
update |
Aktualizuje filtry na úrovni filtru. Výchozí úroveň filtru je úroveň vizuálu.
|
Zděděné metody
add |
Add context menu extension command.
|
add |
Přidání příkazu rozšíření nabídky Možnosti
|
add |
Přidání prázdné stránky do sestavy
|
apply |
Použití motivu v sestavě
|
are |
Vrátí, pokud se v sestavě použijí filtry, průřezy nebo jiné změny zobrazení dat uživatele. Pokud jsou trvalé filtry zakázány, vrátí hodnotu false.
|
clear |
Vymaže vybrané vizuály, které se nevypnou, pokud je příznak předán, výběry všech vizuálů se vymažou.
|
close |
Zavře všechny otevřené místní nabídky a popisy.
|
config |
Zpracování změn konfigurace |
delete |
Odstranění stránky ze sestavy
|
exit |
Požádá prohlížeč o ukončení režimu zobrazení na celé obrazovce. |
fullscreen() | Požádá prohlížeč o vykreslení prvku iframe komponenty v režimu celé obrazovky. |
get |
Získá aktivní stránku sestavy.
|
get |
Získejte ID korelace pro aktuální relaci vložení.
|
get |
Získá ID sestavy z prvního dostupného umístění: možnosti, atribut, adresa URL pro vložení. |
get |
Získá stránku sestavy podle názvu.
|
get |
získání motivu sestavy
|
get |
Vrátí aktuální úroveň přiblížení sestavy. |
is |
zkontroluje, jestli je sestava uložená.
|
move |
Aktualizuje pozici vizuálu na stránce.
|
off<T>(string, IEvent |
Odebere jeden nebo více obslužných rutin událostí ze seznamu obslužných rutin. Pokud je zadán odkaz na existující funkci popisovače, odeberte konkrétní obslužnou rutinu. Pokud není zadaná obslužná rutina, odeberte všechny obslužné rutiny pro zadaný název události.
|
on<T>(string, IEvent |
Přidá obslužnou rutinu události pro konkrétní událost.
|
print() | Vytiskne aktivní stránku sestavy vyvoláním |
refresh() | Aktualizuje zdroje dat pro sestavu.
|
reload() | Znovu načte vložení pomocí existující konfigurace. Například u sestav to efektivně vymaže všechny filtry a aktivuje první stránku, která simuluje resetování sestavy zpět do načteného stavu.
|
remove |
Odebere atribut tabindex elementu. |
remove |
Odeberte příkaz rozšíření místní nabídky.
|
remove |
Příkaz pro odebrání rozšíření nabídky Možnosti
|
rename |
Přejmenování stránky ze sestavy
|
reset |
Resetování filtrů, průřezů a dalších zobrazení dat uživatele ve výchozím stavu sestavy
|
reset |
Resetování a použití výchozího motivu sestavy
|
resize |
Aktualizuje velikost aktivní stránky v sestavě.
|
resize |
Změna velikosti vizuálu na stránce
|
save() | Uloží sestavu. |
save |
Sestava SaveAs |
save |
Uložení filtrů, průřezů a dalších změn zobrazení dat v sestavě uživatele
|
set |
Nastavte accessToken. |
set |
Nastaví atribut tabindex elementu. |
set |
Nastavte název komponenty pro usnadnění přístupu. V případě elementů iframe tato metoda změní název prvku iframe. |
set |
Aktualizuje stav zobrazení vizuálu na stránce.
|
set |
Nastaví úroveň přiblížení sestavy. |
switch |
Aktualizuje rozložení sestavy.
|
switch |
Přepnout režim zobrazení sestavy |
update |
Aktualizuje nastavení viditelnosti pro podokno filtru a navigační podokno stránky.
|
Podrobnosti zděděných vlastností
bookmarksManager
Podrobnosti metody
getFilters(FiltersLevel)
Získá filtry použité na úrovni filtru. Výchozí úroveň filtru je úroveň vizuálu.
visual.getFilters(filtersLevel)
.then(filters => {
...
});
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>
Parametry
- filtersLevel
- FiltersLevel
Návraty
Promise<IFilter[]>
getPages()
Získá seznam stránek v sestavě – není podporován ve vizuálu.
function getPages(): Promise<Page[]>
Návraty
Promise<Page[]>
getVisualDescriptor()
Získá vložený objekt popisovače vizuálu, který obsahuje název vizuálu, typ atd.
visual.getVisualDescriptor()
.then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>
Návraty
Promise<VisualDescriptor>
removeFilters(FiltersLevel)
Odebere všechny filtry z aktuální úrovně filtru. Výchozí úroveň filtru je úroveň vizuálu.
visual.removeFilters(filtersLevel);
function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parametry
- filtersLevel
- FiltersLevel
Návraty
Promise<IHttpPostMessageResponse<void>>
setFilters(IFilter[], FiltersLevel)
Nastaví filtry na úrovni filtru. Výchozí úroveň filtru je úroveň vizuálu.
const filters: [
...
];
visual.setFilters(filters, filtersLevel)
.catch(errors => {
...
});
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parametry
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Návraty
Promise<IHttpPostMessageResponse<void>>
setPage(string)
Nastaví aktivní stránku sestavy – není podporována ve vizuálu.
function setPage(_pageName: string): Promise<IHttpPostMessageResponse<void>>
Parametry
- _pageName
-
string
Návraty
Promise<IHttpPostMessageResponse<void>>
updateFilters(FiltersOperations, IFilter[], FiltersLevel)
Aktualizuje filtry na úrovni filtru. Výchozí úroveň filtru je úroveň vizuálu.
const filters: [
...
];
visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
.catch(errors => {
...
});
function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parametry
- operation
- FiltersOperations
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Návraty
Promise<IHttpPostMessageResponse<void>>
Podrobnosti zděděných metod
addContextMenuCommand(string, string, string, MenuLocation, string, string, string)
Add context menu extension command.
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>>
Parametry
- commandName
-
string
- commandTitle
-
string
- contextMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděno zReport.addContextMenuCommand
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)
Přidání příkazu rozšíření nabídky Možnosti
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>>
Parametry
- commandName
-
string
- commandTitle
-
string
- optionsMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
- commandIcon
-
string
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděno zReport.addOptionsMenuCommand
addPage(string)
Přidání prázdné stránky do sestavy
// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");
function addPage(displayName?: string): Promise<Page>
Parametry
- displayName
-
string
Návraty
Promise<Page>
zděděno ze souboruReport.addPage
applyTheme(IReportTheme)
Použití motivu v sestavě
report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>
Parametry
- theme
- IReportTheme
Návraty
Promise<void>
zděděno ze sestavy.applyTheme
arePersistentFiltersApplied()
Vrátí, pokud se v sestavě použijí filtry, průřezy nebo jiné změny zobrazení dat uživatele. Pokud jsou trvalé filtry zakázány, vrátí hodnotu false.
report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>
Návraty
Promise<boolean>
zděděno ze sestavy.arePersistentFiltersApplied
clearSelectedVisuals(boolean)
Vymaže vybrané vizuály, které se nevypnou, pokud je příznak předán, výběry všech vizuálů se vymažou.
report.clearSelectedVisuals()
.then(() => {
...
});
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>
Parametry
- clearPopOutState
-
boolean
Pokud výběr nedefinovaných nebo nedefinovaných vizuálů nebude vymazán, pokud je některý z vizuálů v rozbaleném stavu (fokus, zobrazit jako tabulku, spotlight...)
Návraty
Promise<void>
zděděné zReport.clearSelectedVisuals
closeAllOverlays()
Zavře všechny otevřené místní nabídky a popisy.
report.closeAllOverlays()
.then(() => {
...
});
function closeAllOverlays(): Promise<void>
Návraty
Promise<void>
zděděno ze sestavyReport.closeAllOverlays
configChanged(boolean)
Zpracování změn konfigurace
function configChanged(isBootstrap: boolean)
Parametry
- isBootstrap
-
boolean
deletePage(string)
Odstranění stránky ze sestavy
// 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>
Parametry
- pageName
-
string
Návraty
Promise<void>
zděděno ze souboruReport.deletePage
exitFullscreen()
Požádá prohlížeč o ukončení režimu zobrazení na celé obrazovce.
function exitFullscreen()
fullscreen()
Požádá prohlížeč o vykreslení prvku iframe komponenty v režimu celé obrazovky.
function fullscreen()
getActivePage()
Získá aktivní stránku sestavy.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
Návraty
Promise<Page>
zděděno zReport.getActivePage
getCorrelationId()
Získejte ID korelace pro aktuální relaci vložení.
// Get the correlationId for the current embed session
report.getCorrelationId()
.then(correlationId => {
...
});
function getCorrelationId(): Promise<string>
Návraty
Promise<string>
zděděno zReport.getCorrelationId
getId()
Získá ID sestavy z prvního dostupného umístění: možnosti, atribut, adresa URL pro vložení.
function getId(): string
Návraty
string
zděděno zReport.getId
getPageByName(string)
Získá stránku sestavy podle názvu.
report.getPageByName(pageName)
.then(page => {
...
});
function getPageByName(pageName: string): Promise<Page>
Parametry
- pageName
-
string
Návraty
Promise<Page>
zděděno zReport.getPageByName
getTheme()
získání motivu sestavy
report.getTheme();
function getTheme(): Promise<IReportTheme>
Návraty
Promise<IReportTheme>
zděděno zReport.getTheme
getZoom()
Vrátí aktuální úroveň přiblížení sestavy.
function getZoom(): Promise<number>
Návraty
Promise<number>
zděděno zeReport.getZoom
isSaved()
zkontroluje, jestli je sestava uložená.
report.isSaved()
function isSaved(): Promise<boolean>
Návraty
Promise<boolean>
zděděno ze sestavy.isSaved
moveVisual(string, string, number, number, number)
Aktualizuje pozici vizuálu na stránce.
report.moveVisual(pageName, visualName, x, y, z)
.catch(error => { ... });
function moveVisual(pageName: string, visualName: string, x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>
Parametry
- pageName
-
string
- visualName
-
string
- x
-
number
- y
-
number
- z
-
number
Návraty
Promise<IHttpPostMessageResponse<void>>
off<T>(string, IEventHandler<T>)
Odebere jeden nebo více obslužných rutin událostí ze seznamu obslužných rutin. Pokud je zadán odkaz na existující funkci popisovače, odeberte konkrétní obslužnou rutinu. Pokud není zadaná obslužná rutina, odeberte všechny obslužné rutiny pro zadaný název události.
report.off('pageChanged')
or
const logHandler = function (event) {
console.log(event);
};
report.off('pageChanged', logHandler);
function off<T>(eventName: string, handler?: IEventHandler<T>)
Parametry
- eventName
-
string
- handler
-
IEventHandler<T>
zděděno zReport.off
on<T>(string, IEventHandler<T>)
Přidá obslužnou rutinu události pro konkrétní událost.
report.on('pageChanged', (event) => {
console.log('PageChanged: ', event.page.name);
});
function on<T>(eventName: string, handler: IEventHandler<T>)
Parametry
- eventName
-
string
- handler
-
IEventHandler<T>
zděděno zeReport.on
print()
Vytiskne aktivní stránku sestavy vyvoláním window.print()
na komponentě iframe pro vložení.
function print(): Promise<void>
Návraty
Promise<void>
zděděno zeReport.print
refresh()
Aktualizuje zdroje dat pro sestavu.
report.refresh();
function refresh(): Promise<void>
Návraty
Promise<void>
zděděno zeReport.refresh
reload()
Znovu načte vložení pomocí existující konfigurace. Například u sestav to efektivně vymaže všechny filtry a aktivuje první stránku, která simuluje resetování sestavy zpět do načteného stavu.
report.reload();
function reload(): Promise<void>
Návraty
Promise<void>
zděděno ze souboruReport.reload
removeComponentTabIndex(number)
Odebere atribut tabindex elementu.
function removeComponentTabIndex(_tabIndex?: number)
Parametry
- _tabIndex
-
number
zděděno zReport.removeComponentTabIndex
removeContextMenuCommand(string, string)
Odeberte příkaz rozšíření místní nabídky.
report.removeContextMenuCommand(commandName, contextMenuTitle)
.catch(error => {
...
});
function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Parametry
- commandName
-
string
- contextMenuTitle
-
string
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděno ze sestavyReport.removeContextMenuCommand
removeOptionsMenuCommand(string, string)
Příkaz pro odebrání rozšíření nabídky Možnosti
report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
.then({
...
});
function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Parametry
- commandName
-
string
- optionsMenuTitle
-
string
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděno zReport.removeOptionsMenuCommand
renamePage(string, string)
Přejmenování stránky ze sestavy
// 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>
Parametry
- pageName
-
string
- displayName
-
string
Návraty
Promise<void>
zděděno ze souboruReport.renamePage
resetPersistentFilters()
Resetování filtrů, průřezů a dalších zobrazení dat uživatele ve výchozím stavu sestavy
report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděno zReport.resetPersistentFilters
resetTheme()
Resetování a použití výchozího motivu sestavy
report.resetTheme();
function resetTheme(): Promise<void>
Návraty
Promise<void>
zděděno zReport.resetTheme
resizeActivePage(PageSizeType, number, number)
Aktualizuje velikost aktivní stránky v sestavě.
report.resizeActivePage(pageSizeType, width, height)
.catch(error => { ... });
function resizeActivePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>>
Parametry
- pageSizeType
- PageSizeType
- width
-
number
- height
-
number
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděno zReport.resizeActivePage
resizeVisual(string, string, number, number)
Změna velikosti vizuálu na stránce
report.resizeVisual(pageName, visualName, width, height)
.catch(error => { ... });
function resizeVisual(pageName: string, visualName: string, width: number, height: number): Promise<IHttpPostMessageResponse<void>>
Parametry
- pageName
-
string
- visualName
-
string
- width
-
number
- height
-
number
Návraty
Promise<IHttpPostMessageResponse<void>>
save()
saveAs(ISaveAsParameters)
Sestava SaveAs
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
Parametry
- saveAsParameters
- ISaveAsParameters
Návraty
Promise<void>
zděděno zReport.saveAs
savePersistentFilters()
Uložení filtrů, průřezů a dalších změn zobrazení dat v sestavě uživatele
report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděné zReport.savePersistentFilters
setAccessToken(string)
Nastavte accessToken.
function setAccessToken(accessToken: string): Promise<void>
Parametry
- accessToken
-
string
Návraty
Promise<void>
setComponentTabIndex(number)
Nastaví atribut tabindex elementu.
function setComponentTabIndex(tabIndex?: number)
Parametry
- tabIndex
-
number
zděděno zReport.setComponentTabIndex
setComponentTitle(string)
Nastavte název komponenty pro usnadnění přístupu. V případě elementů iframe tato metoda změní název prvku iframe.
function setComponentTitle(title: string)
Parametry
- title
-
string
zděděno zReport.setComponentTitle
setVisualDisplayState(string, string, VisualContainerDisplayMode)
Aktualizuje stav zobrazení vizuálu na stránce.
report.setVisualDisplayState(pageName, visualName, displayState)
.catch(error => { ... });
function setVisualDisplayState(pageName: string, visualName: string, displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>
Parametry
- pageName
-
string
- visualName
-
string
- displayState
- VisualContainerDisplayMode
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděno zReport.setVisualDisplayState
setZoom(number)
Nastaví úroveň přiblížení sestavy.
function setZoom(zoomLevel: number): Promise<void>
Parametry
- zoomLevel
-
number
úroveň přiblížení, která se má nastavit
Návraty
Promise<void>
zděděno zReport.setZoom
switchLayout(LayoutType)
Aktualizuje rozložení sestavy.
report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>
Parametry
- layoutType
- LayoutType
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděno zReport.switchLayout
switchMode(string | ViewMode)
Přepnout režim zobrazení sestavy
function switchMode(viewMode: string | ViewMode): Promise<void>
Parametry
- viewMode
-
string | ViewMode
Návraty
Promise<void>
updateSettings(ISettings)
Aktualizuje nastavení viditelnosti pro podokno filtru a navigační podokno stránky.
const newSettings = {
panes: {
filters: {
visible: false
}
}
};
report.updateSettings(newSettings)
.catch(error => { ... });
function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>
Parametry
- settings
- ISettings
Návraty
Promise<IHttpPostMessageResponse<void>>
zděděno zReport.updateSettings