Visual class
A Power BI-vizualizáció beágyazási összetevője
- Extends
Örökölt tulajdonságok
| bookmarks |
Metódusok
| get |
Lekéri a szűrőszintre alkalmazott szűrőket. Az alapértelmezett szűrőszint a vizualizáció szintje.
|
| get |
Lekéri a jelentés lapjainak listáját – vizualizációban nem támogatott |
| get |
Lekéri a vizualizáció nevét, típusát stb. tartalmazó beágyazott vizualizációleíró objektumot.
|
| remove |
Eltávolítja az összes szűrőt az aktuális szűrőszintről. Az alapértelmezett szűrőszint a vizualizáció szintje.
|
| set |
Szűrőszinten állítja be a szűrőket. Az alapértelmezett szűrőszint a vizualizáció szintje.
|
| set |
A jelentés aktív lapjának beállítása – vizualizációban nem támogatott |
| update |
Szűrőszinten frissíti a szűrőket. Az alapértelmezett szűrőszint a vizualizáció szintje.
|
Örökölt metódusok
| add |
Helyi menü bővítményparancsának hozzáadása.
|
| add |
Beállítások hozzáadása menübővítmény parancsa.
|
| add |
Üres lap hozzáadása a jelentéshez
|
| apply |
Téma alkalmazása a jelentésre
|
| are |
Visszaadja, ha a jelentésen felhasználói szűrők, szeletelők vagy más adatnézet-módosítások vannak alkalmazva. Ha az állandó szűrők le van tiltva, hamis értéket ad vissza.
|
| clear |
Törli a kijelölt nem kiugró vizualizációkat, ha a jelölő átadása megtörtént, az összes vizualizáció kijelölése törlődik.
|
| close |
Bezárja az összes megnyitott helyi menüt és elemleírást.
|
| config |
Konfigurációs módosítások kezelése. |
| delete |
Lap törlése jelentésből
|
| exit |
Kéri a böngészőt, hogy lépjen ki a teljes képernyős módból. |
| fullscreen() | Kéri a böngészőt, hogy teljes képernyős módban renderelje az összetevő iframe-jét. |
| get |
Lekéri az aktív jelentésoldalt.
|
| get |
Kérje le az aktuális beágyazási munkamenet korrelációs azonosítóját.
|
| get |
Lekéri a jelentésazonosítót az első elérhető helyről: beállítások, attribútum, beágyazási URL-cím. |
| get |
Lekéri a jelentésoldalt a neve alapján.
|
| get |
a jelentés témájának lekérése
|
| get |
A jelentés aktuális nagyítási szintjét adja vissza. |
| is |
ellenőrzi, hogy a jelentés mentése megtörtént-e.
|
| move |
Frissíti egy vizualizáció pozícióját egy lapon.
|
| off<T>(string, IEvent |
Eltávolít egy vagy több eseménykezelőt a kezelők listájából. Ha a meglévő leírófüggvényre mutató hivatkozás van megadva, távolítsa el az adott kezelőt. Ha a kezelő nincs megadva, távolítsa el a megadott eseménynévhez tartozó összes kezelőt.
|
| on<T>(string, IEvent |
Hozzáad egy eseménykezelőt egy adott eseményhez.
|
| print() | A jelentés aktív oldalának nyomtatása a beágyazási iframe összetevőre |
| refresh() | Frissíti a jelentés adatforrását.
|
| reload() | Újra betölti a beágyazást a meglévő konfigurációval. Például a jelentések esetében ez hatékonyan törli az összes szűrőt, és aktívvá teszi az első oldalt, amely szimulálja a jelentés alaphelyzetbe állítását betöltött állapotba.
|
| remove |
Eltávolítja az elem tabindex attribútumát |
| remove |
Távolítsa el a helyi menü bővítményparancsát.
|
| remove |
A Beállítások menü bővítmény parancsa.
|
| rename |
Lap átnevezése jelentésből
|
| reset |
A felhasználó szűrőinek, szeletelőinek és egyéb adatnézetének módosítása a jelentés alapértelmezett állapotára
|
| reset |
A jelentés alapértelmezett témájának alaphelyzetbe állítása és alkalmazása
|
| resize |
Frissíti a jelentés aktív lapjának méretét.
|
| resize |
Vizualizáció átméretezése egy lapon.
|
| save() | Jelentés mentése. |
| save |
SaveAs-jelentés. |
| save |
A jelentés felhasználói szűrőinek, szeletelőinek és egyéb adatnézet-módosításainak mentése
|
| set |
Az accessToken beállítása. |
| set |
Az elem tabindex attribútumának beállítása |
| set |
Állítsa be az összetevő címét az akadálymentességhez. Iframe-ek esetén ez a módszer megváltoztatja az iframe címét. |
| set |
Frissíti egy vizualizáció megjelenítési állapotát egy lapon.
|
| set |
Beállítja a jelentés nagyítási szintjét. |
| switch |
A jelentés elrendezésének frissítése
|
| switch |
Váltás jelentésnézet módra. |
| update |
Frissíti a szűrőpanel és a lap navigációs ablakának láthatósági beállításait.
|
Örökölt tulajdonság részletei
bookmarksManager
Metódus adatai
getFilters(FiltersLevel)
Lekéri a szűrőszintre alkalmazott szűrőket. Az alapértelmezett szűrőszint a vizualizáció szintje.
visual.getFilters(filtersLevel)
.then(filters => {
...
});
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>
Paraméterek
- filtersLevel
- FiltersLevel
Válaszok
Promise<IFilter[]>
getPages()
Lekéri a jelentés lapjainak listáját – vizualizációban nem támogatott
function getPages(): Promise<Page[]>
Válaszok
Promise<Page[]>
getVisualDescriptor()
Lekéri a vizualizáció nevét, típusát stb. tartalmazó beágyazott vizualizációleíró objektumot.
visual.getVisualDescriptor()
.then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>
Válaszok
Promise<VisualDescriptor>
removeFilters(FiltersLevel)
Eltávolítja az összes szűrőt az aktuális szűrőszintről. Az alapértelmezett szűrőszint a vizualizáció szintje.
visual.removeFilters(filtersLevel);
function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- filtersLevel
- FiltersLevel
Válaszok
Promise<IHttpPostMessageResponse<void>>
setFilters(IFilter[], FiltersLevel)
Szűrőszinten állítja be a szűrőket. Az alapértelmezett szűrőszint a vizualizáció szintje.
const filters: [
...
];
visual.setFilters(filters, filtersLevel)
.catch(errors => {
...
});
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Válaszok
Promise<IHttpPostMessageResponse<void>>
setPage(string)
A jelentés aktív lapjának beállítása – vizualizációban nem támogatott
function setPage(_pageName: string): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- _pageName
-
string
Válaszok
Promise<IHttpPostMessageResponse<void>>
updateFilters(FiltersOperations, IFilter[], FiltersLevel)
Szűrőszinten frissíti a szűrőket. Az alapértelmezett szűrőszint a vizualizáció szintje.
const filters: [
...
];
visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
.catch(errors => {
...
});
function updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- operation
- FiltersOperations
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Válaszok
Promise<IHttpPostMessageResponse<void>>
Örökölt metódus részletei
addContextMenuCommand(string, string, string, MenuLocation, string, string, string)
Helyi menü bővítményparancsának hozzáadása.
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>>
Paraméterek
- commandName
-
string
- commandTitle
-
string
- contextMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
Válaszok
Promise<IHttpPostMessageResponse<void>>
örököltReport.addContextMenuCommand
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)
Beállítások hozzáadása menübővítmény parancsa.
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>>
Paraméterek
- commandName
-
string
- commandTitle
-
string
- optionsMenuTitle
-
string
- menuLocation
- MenuLocation
- visualName
-
string
- visualType
-
string
- groupName
-
string
- commandIcon
-
string
Válaszok
Promise<IHttpPostMessageResponse<void>>
örököltReport.addOptionsMenuCommand
addPage(string)
Üres lap hozzáadása a jelentéshez
// Add a page to the report with "Sales" as the page display name
report.addPage("Sales");
function addPage(displayName?: string): Promise<Page>
Paraméterek
- displayName
-
string
Válaszok
Promise<Page>
örököltReport.addPage
applyTheme(IReportTheme)
Téma alkalmazása a jelentésre
report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>
Paraméterek
- theme
- IReportTheme
Válaszok
Promise<void>
örököltReport.applyTheme
arePersistentFiltersApplied()
Visszaadja, ha a jelentésen felhasználói szűrők, szeletelők vagy más adatnézet-módosítások vannak alkalmazva. Ha az állandó szűrők le van tiltva, hamis értéket ad vissza.
report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>
Válaszok
Promise<boolean>
clearSelectedVisuals(boolean)
Törli a kijelölt nem kiugró vizualizációkat, ha a jelölő átadása megtörtént, az összes vizualizáció kijelölése törlődik.
report.clearSelectedVisuals()
.then(() => {
...
});
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>
Paraméterek
- clearPopOutState
-
boolean
Ha a hamis/ nem definiált vizualizációk kijelölése nem törlődik, ha az egyik vizualizáció kiugró állapotban van (fókuszban, megjelenítés táblázatként, reflektorfény...)
Válaszok
Promise<void>
örököltReport.clearSelectedVisuals
closeAllOverlays()
Bezárja az összes megnyitott helyi menüt és elemleírást.
report.closeAllOverlays()
.then(() => {
...
});
function closeAllOverlays(): Promise<void>
Válaszok
Promise<void>
örököltReport.closeAllOverlays
configChanged(boolean)
Konfigurációs módosítások kezelése.
function configChanged(isBootstrap: boolean)
Paraméterek
- isBootstrap
-
boolean
örököltReport.configChanged
deletePage(string)
Lap törlése jelentésből
// 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>
Paraméterek
- pageName
-
string
Válaszok
Promise<void>
örököltReport.deletePage
exitFullscreen()
Kéri a böngészőt, hogy lépjen ki a teljes képernyős módból.
function exitFullscreen()
örököltReport.exitFullscreen
fullscreen()
Kéri a böngészőt, hogy teljes képernyős módban renderelje az összetevő iframe-jét.
function fullscreen()
getActivePage()
Lekéri az aktív jelentésoldalt.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
Válaszok
Promise<Page>
örököltReport.getActivePage
getCorrelationId()
Kérje le az aktuális beágyazási munkamenet korrelációs azonosítóját.
// Get the correlationId for the current embed session
report.getCorrelationId()
.then(correlationId => {
...
});
function getCorrelationId(): Promise<string>
Válaszok
Promise<string>
örököltReport.getCorrelationId
getId()
Lekéri a jelentésazonosítót az első elérhető helyről: beállítások, attribútum, beágyazási URL-cím.
function getId(): string
Válaszok
string
örököltReport.getId
getPageByName(string)
Lekéri a jelentésoldalt a neve alapján.
report.getPageByName(pageName)
.then(page => {
...
});
function getPageByName(pageName: string): Promise<Page>
Paraméterek
- pageName
-
string
Válaszok
Promise<Page>
örököltReport.getPageByName
getTheme()
a jelentés témájának lekérése
report.getTheme();
function getTheme(): Promise<IReportTheme>
Válaszok
Promise<IReportTheme>
örököltReport.getTheme
getZoom()
A jelentés aktuális nagyítási szintjét adja vissza.
function getZoom(): Promise<number>
Válaszok
Promise<number>
örököltReport.getZoom
isSaved()
ellenőrzi, hogy a jelentés mentése megtörtént-e.
report.isSaved()
function isSaved(): Promise<boolean>
Válaszok
Promise<boolean>
moveVisual(string, string, number, number, number)
Frissíti egy vizualizáció pozícióját egy lapon.
report.moveVisual(pageName, visualName, x, y, z)
.catch(error => { ... });
function moveVisual(pageName: string, visualName: string, x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- pageName
-
string
- visualName
-
string
- x
-
number
- y
-
number
- z
-
number
Válaszok
Promise<IHttpPostMessageResponse<void>>
örököltReport.moveVisual
off<T>(string, IEventHandler<T>)
Eltávolít egy vagy több eseménykezelőt a kezelők listájából. Ha a meglévő leírófüggvényre mutató hivatkozás van megadva, távolítsa el az adott kezelőt. Ha a kezelő nincs megadva, távolítsa el a megadott eseménynévhez tartozó összes kezelőt.
report.off('pageChanged')
or
const logHandler = function (event) {
console.log(event);
};
report.off('pageChanged', logHandler);
function off<T>(eventName: string, handler?: IEventHandler<T>)
Paraméterek
- eventName
-
string
- handler
-
IEventHandler<T>
örököltReport.off
on<T>(string, IEventHandler<T>)
Hozzáad egy eseménykezelőt egy adott eseményhez.
report.on('pageChanged', (event) => {
console.log('PageChanged: ', event.page.name);
});
function on<T>(eventName: string, handler: IEventHandler<T>)
Paraméterek
- eventName
-
string
- handler
-
IEventHandler<T>
örököltReport.on
print()
A jelentés aktív oldalának nyomtatása a beágyazási iframe összetevőre window.print() meghívásával.
function print(): Promise<void>
Válaszok
Promise<void>
örököltReport.print
refresh()
Frissíti a jelentés adatforrását.
report.refresh();
function refresh(): Promise<void>
Válaszok
Promise<void>
örököltReport.refresh
reload()
Újra betölti a beágyazást a meglévő konfigurációval. Például a jelentések esetében ez hatékonyan törli az összes szűrőt, és aktívvá teszi az első oldalt, amely szimulálja a jelentés alaphelyzetbe állítását betöltött állapotba.
report.reload();
function reload(): Promise<void>
Válaszok
Promise<void>
örököltReport.reload
removeComponentTabIndex(number)
Eltávolítja az elem tabindex attribútumát
function removeComponentTabIndex(_tabIndex?: number)
Paraméterek
- _tabIndex
-
number
removeContextMenuCommand(string, string)
Távolítsa el a helyi menü bővítményparancsát.
report.removeContextMenuCommand(commandName, contextMenuTitle)
.catch(error => {
...
});
function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- commandName
-
string
- contextMenuTitle
-
string
Válaszok
Promise<IHttpPostMessageResponse<void>>
removeOptionsMenuCommand(string, string)
A Beállítások menü bővítmény parancsa.
report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
.then({
...
});
function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- commandName
-
string
- optionsMenuTitle
-
string
Válaszok
Promise<IHttpPostMessageResponse<void>>
renamePage(string, string)
Lap átnevezése jelentésből
// 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>
Paraméterek
- pageName
-
string
- displayName
-
string
Válaszok
Promise<void>
ÖrököltReport.renamePage
resetPersistentFilters()
A felhasználó szűrőinek, szeletelőinek és egyéb adatnézetének módosítása a jelentés alapértelmezett állapotára
report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Válaszok
Promise<IHttpPostMessageResponse<void>>
resetTheme()
A jelentés alapértelmezett témájának alaphelyzetbe állítása és alkalmazása
report.resetTheme();
function resetTheme(): Promise<void>
Válaszok
Promise<void>
örököltReport.resetTheme
resizeActivePage(PageSizeType, number, number)
Frissíti a jelentés aktív lapjának méretét.
report.resizeActivePage(pageSizeType, width, height)
.catch(error => { ... });
function resizeActivePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- pageSizeType
- PageSizeType
- width
-
number
- height
-
number
Válaszok
Promise<IHttpPostMessageResponse<void>>
ÖrököltReport.resizeActivePage
resizeVisual(string, string, number, number)
Vizualizáció átméretezése egy lapon.
report.resizeVisual(pageName, visualName, width, height)
.catch(error => { ... });
function resizeVisual(pageName: string, visualName: string, width: number, height: number): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- pageName
-
string
- visualName
-
string
- width
-
number
- height
-
number
Válaszok
Promise<IHttpPostMessageResponse<void>>
örököltReport.resizeVisual
save()
saveAs(ISaveAsParameters)
SaveAs-jelentés.
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
Paraméterek
- saveAsParameters
- ISaveAsParameters
Válaszok
Promise<void>
örököltReport.saveAs
savePersistentFilters()
A jelentés felhasználói szűrőinek, szeletelőinek és egyéb adatnézet-módosításainak mentése
report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Válaszok
Promise<IHttpPostMessageResponse<void>>
örököltReport.savePersistentFilters
setAccessToken(string)
Az accessToken beállítása.
function setAccessToken(accessToken: string): Promise<void>
Paraméterek
- accessToken
-
string
Válaszok
Promise<void>
örököltReport.setAccessToken
setComponentTabIndex(number)
Az elem tabindex attribútumának beállítása
function setComponentTabIndex(tabIndex?: number)
Paraméterek
- tabIndex
-
number
örököltReport.setComponentTabIndex
setComponentTitle(string)
Állítsa be az összetevő címét az akadálymentességhez. Iframe-ek esetén ez a módszer megváltoztatja az iframe címét.
function setComponentTitle(title: string)
Paraméterek
- title
-
string
örököltReport.setComponentTitle
setVisualDisplayState(string, string, VisualContainerDisplayMode)
Frissíti egy vizualizáció megjelenítési állapotát egy lapon.
report.setVisualDisplayState(pageName, visualName, displayState)
.catch(error => { ... });
function setVisualDisplayState(pageName: string, visualName: string, displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- pageName
-
string
- visualName
-
string
- displayState
- VisualContainerDisplayMode
Válaszok
Promise<IHttpPostMessageResponse<void>>
örököltReport.setVisualDisplayState
setZoom(number)
Beállítja a jelentés nagyítási szintjét.
function setZoom(zoomLevel: number): Promise<void>
Paraméterek
- zoomLevel
-
number
nagyítási szint beállítása
Válaszok
Promise<void>
örököltReport.setZoom
switchLayout(LayoutType)
A jelentés elrendezésének frissítése
report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- layoutType
- LayoutType
Válaszok
Promise<IHttpPostMessageResponse<void>>
ÖrököltReport.switchLayout
switchMode(string | ViewMode)
Váltás jelentésnézet módra.
function switchMode(viewMode: string | ViewMode): Promise<void>
Paraméterek
- viewMode
-
string | ViewMode
Válaszok
Promise<void>
örököltReport.switchMode
updateSettings(ISettings)
Frissíti a szűrőpanel és a lap navigációs ablakának láthatósági beállításait.
const newSettings = {
panes: {
filters: {
visible: false
}
}
};
report.updateSettings(newSettings)
.catch(error => { ... });
function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>
Paraméterek
- settings
- ISettings
Válaszok
Promise<IHttpPostMessageResponse<void>>
örököltReport.updateSettings