Visual class
Einbettungskomponente für Power BI Visual
- Extends
Geerbte Eigenschaften
bookmarks |
Methoden
get |
Ruft Filter ab, die auf die Filterebene angewendet werden. Die Standardfilterebene ist die visuelle Ebene.
|
get |
Ruft die Liste der Seiten innerhalb des Berichts ab , die in visual nicht unterstützt werden. |
get |
Ruft das eingebettete visuelle Deskriptorobjekt ab, das den Visuellen Namen, den Typ usw. enthält.
|
remove |
Entfernt alle Filter aus der aktuellen Filterebene. Die Standardfilterebene ist die visuelle Ebene.
|
set |
Legt Filter auf Filterebene fest. Die Standardfilterebene ist die visuelle Ebene.
|
set |
Legt die aktive Seite des Berichts fest , die in visual nicht unterstützt wird. |
update |
Aktualisierungen Filter auf Filterebene. Die Standardfilterebene ist die visuelle Ebene.
|
Geerbte Methoden
add |
Hinzufügen des Kontextmenüerweiterungsbefehls.
|
add |
Menüerweiterungsbefehl "Optionen hinzufügen".
|
add |
Hinzufügen einer leeren Seite zum Bericht
|
apply |
Anwenden eines Designs auf den Bericht
|
are |
Gibt zurück, wenn filter, slicer oder andere Datenansichtsänderungen des Benutzers auf den Bericht angewendet werden. Wenn persistente Filter deaktiviert sind, gibt false zurück.
|
clear |
Löscht ausgewählte, nicht ausgeklallte Visuals. Wenn das Flag übergeben wird, werden alle Visuals-Auswahlen gelöscht.
|
close |
Schließt alle geöffneten Kontextmenüs und QuickInfos.
|
config |
Behandeln von Konfigurationsänderungen. |
delete |
Löschen einer Seite aus einem Bericht
|
exit |
Fordert den Browser auf, den Vollbildmodus zu beenden. |
fullscreen() | Fordert den Browser auf, den iFrame der Komponente im Vollbildmodus zu rendern. |
get |
Ruft die aktive Berichtsseite ab.
|
get |
Rufen Sie die correlationId für die aktuelle Einbettungssitzung ab.
|
get |
Ruft die Berichts-ID vom ersten verfügbaren Speicherort ab: Optionen, Attribut, Einbettungs-URL. |
get |
Ruft eine Berichtsseite nach ihrem Namen ab.
|
get |
Abrufen des Berichtsdesigns
|
get |
Gibt den aktuellen Zoomfaktor des Berichts zurück. |
is |
überprüft, ob der Bericht gespeichert ist.
|
move |
Aktualisierungen die Position eines Visuals auf einer Seite.
|
off<T>(string, IEvent |
Entfernt einen oder mehrere Ereignishandler aus der Liste der Handler. Wenn ein Verweis auf die vorhandene Handle-Funktion angegeben wird, entfernen Sie den spezifischen Handler. Wenn der Handler nicht angegeben ist, entfernen Sie alle Handler für den angegebenen Ereignisnamen.
|
on<T>(string, IEvent |
Fügt einen Ereignishandler für ein bestimmtes Ereignis hinzu.
|
print() | Gibt die aktive Seite des Berichts durch Aufrufen |
refresh() | Aktualisiert Datenquellen für den Bericht.
|
reload() | Lädt die Einbettung mithilfe einer vorhandenen Konfiguration neu. Für Berichte werden z. B. alle Filter gelöscht und die erste Seite aktiviert, die das Zurücksetzen eines Berichts auf den geladenen Zustand simuliert.
|
remove |
Entfernt das tabindex-Attribut des Elements. |
remove |
Kontextmenüerweiterungsbefehl entfernen.
|
remove |
Menüerweiterungsbefehl "Optionen entfernen".
|
rename |
Umbenennen einer Seite aus einem Bericht
|
reset |
Zurücksetzen von Filtern, Slicern und anderen Datenansichtsänderungen des Benutzers auf den Standardzustand des Berichts
|
reset |
Zurücksetzen und Anwenden des Standarddesigns des Berichts
|
resize |
Aktualisierungen die Größe der aktiven Seite im Bericht.
|
resize |
Ändern der Größe eines Visuals auf einer Seite.
|
save() | Speichert den Bericht. |
save |
SaveAs Report. |
save |
Speichern von Filtern, Datenschnitten und anderen Datenansichtsänderungen des Berichts
|
set |
Legen Sie accessToken fest. |
set |
Legt das tabindex-Attribut des Elements fest |
set |
Legen Sie den Komponententitel für Barrierefreiheit fest. Im Fall von iframes ändert diese Methode den iframe-Titel. |
set |
Aktualisierungen den Anzeigezustand eines Visuals auf einer Seite.
|
set |
Legt die Zoomstufe des Berichts fest. |
switch |
Aktualisierungen des Berichtslayouts
|
switch |
Wechseln Sie zum Berichtsansichtsmodus. |
update |
Aktualisierungen Sichtbarkeitseinstellungen für den Filterbereich und den Seitennavigationsbereich.
|
Geerbte Eigenschaftsdetails
bookmarksManager
Details zur Methode
getFilters(FiltersLevel)
Ruft Filter ab, die auf die Filterebene angewendet werden. Die Standardfilterebene ist die visuelle Ebene.
visual.getFilters(filtersLevel)
.then(filters => {
...
});
function getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]>
Parameter
- filtersLevel
- FiltersLevel
Gibt zurück
Promise<IFilter[]>
getPages()
Ruft die Liste der Seiten innerhalb des Berichts ab , die in visual nicht unterstützt werden.
function getPages(): Promise<Page[]>
Gibt zurück
Promise<Page[]>
getVisualDescriptor()
Ruft das eingebettete visuelle Deskriptorobjekt ab, das den Visuellen Namen, den Typ usw. enthält.
visual.getVisualDescriptor()
.then(visualDetails => { ... });
function getVisualDescriptor(): Promise<VisualDescriptor>
Gibt zurück
Promise<VisualDescriptor>
removeFilters(FiltersLevel)
Entfernt alle Filter aus der aktuellen Filterebene. Die Standardfilterebene ist die visuelle Ebene.
visual.removeFilters(filtersLevel);
function removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parameter
- filtersLevel
- FiltersLevel
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
setFilters(IFilter[], FiltersLevel)
Legt Filter auf Filterebene fest. Die Standardfilterebene ist die visuelle Ebene.
const filters: [
...
];
visual.setFilters(filters, filtersLevel)
.catch(errors => {
...
});
function setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>>
Parameter
- filters
-
IFilter[]
- filtersLevel
- FiltersLevel
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
setPage(string)
Legt die aktive Seite des Berichts fest , die in visual nicht unterstützt wird.
function setPage(_pageName: string): Promise<IHttpPostMessageResponse<void>>
Parameter
- _pageName
-
string
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
updateFilters(FiltersOperations, IFilter[], FiltersLevel)
Aktualisierungen Filter auf Filterebene. Die Standardfilterebene ist die visuelle Ebene.
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
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Details zur geerbten Methode
addContextMenuCommand(string, string, string, MenuLocation, string, string, string)
Hinzufügen des Kontextmenüerweiterungsbefehls.
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
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.addContextMenuCommand
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)
Menüerweiterungsbefehl "Optionen hinzufügen".
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
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.addOptionsMenuCommand
addPage(string)
Hinzufügen einer leeren Seite zum Bericht
// 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
Gibt zurück
Promise<Page>
Geerbt vonReport.addPage
applyTheme(IReportTheme)
Anwenden eines Designs auf den Bericht
report.applyTheme(theme);
function applyTheme(theme: IReportTheme): Promise<void>
Parameter
- theme
- IReportTheme
Gibt zurück
Promise<void>
Geerbt vonReport.applyTheme
arePersistentFiltersApplied()
Gibt zurück, wenn filter, slicer oder andere Datenansichtsänderungen des Benutzers auf den Bericht angewendet werden. Wenn persistente Filter deaktiviert sind, gibt false zurück.
report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>
Gibt zurück
Promise<boolean>
Geerbt vonReport.arePersistentFiltersApplied
clearSelectedVisuals(boolean)
Löscht ausgewählte, nicht ausgeklallte Visuals. Wenn das Flag übergeben wird, werden alle Visuals-Auswahlen gelöscht.
report.clearSelectedVisuals()
.then(() => {
...
});
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>
Parameter
- clearPopOutState
-
boolean
Wenn false/undefined visuals auswahl nicht gelöscht wird, wenn sich eines der Visuals im Popupzustand befindet (fokus, als Tabelle anzeigen, Spotlight...)
Gibt zurück
Promise<void>
Geerbt vonReport.clearSelectedVisuals
closeAllOverlays()
Schließt alle geöffneten Kontextmenüs und QuickInfos.
report.closeAllOverlays()
.then(() => {
...
});
function closeAllOverlays(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonReport.closeAllOverlays
configChanged(boolean)
Behandeln von Konfigurationsänderungen.
function configChanged(isBootstrap: boolean)
Parameter
- isBootstrap
-
boolean
Geerbt vonReport.configChanged
deletePage(string)
Löschen einer Seite aus einem Bericht
// 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
Gibt zurück
Promise<void>
Geerbt vonReport.deletePage
exitFullscreen()
Fordert den Browser auf, den Vollbildmodus zu beenden.
function exitFullscreen()
Geerbt vonReport.exitFullscreen
fullscreen()
Fordert den Browser auf, den iFrame der Komponente im Vollbildmodus zu rendern.
function fullscreen()
Geerbt vonReport.fullscreen
getActivePage()
Ruft die aktive Berichtsseite ab.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
Gibt zurück
Promise<Page>
Geerbt vonReport.getActivePage
getCorrelationId()
Rufen Sie die correlationId für die aktuelle Einbettungssitzung ab.
// Get the correlationId for the current embed session
report.getCorrelationId()
.then(correlationId => {
...
});
function getCorrelationId(): Promise<string>
Gibt zurück
Promise<string>
Geerbt vonReport.getCorrelationId
getId()
Ruft die Berichts-ID vom ersten verfügbaren Speicherort ab: Optionen, Attribut, Einbettungs-URL.
function getId(): string
Gibt zurück
string
Geerbt vonReport.getId
getPageByName(string)
Ruft eine Berichtsseite nach ihrem Namen ab.
report.getPageByName(pageName)
.then(page => {
...
});
function getPageByName(pageName: string): Promise<Page>
Parameter
- pageName
-
string
Gibt zurück
Promise<Page>
Geerbt vonReport.getPageByName
getTheme()
Abrufen des Berichtsdesigns
report.getTheme();
function getTheme(): Promise<IReportTheme>
Gibt zurück
Promise<IReportTheme>
Geerbt vonReport.getTheme
getZoom()
Gibt den aktuellen Zoomfaktor des Berichts zurück.
function getZoom(): Promise<number>
Gibt zurück
Promise<number>
Geerbt vonReport.getZoom
isSaved()
überprüft, ob der Bericht gespeichert ist.
report.isSaved()
function isSaved(): Promise<boolean>
Gibt zurück
Promise<boolean>
Geerbt vonReport.isSaved
moveVisual(string, string, number, number, number)
Aktualisierungen die Position eines Visuals auf einer Seite.
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
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.moveVisual
off<T>(string, IEventHandler<T>)
Entfernt einen oder mehrere Ereignishandler aus der Liste der Handler. Wenn ein Verweis auf die vorhandene Handle-Funktion angegeben wird, entfernen Sie den spezifischen Handler. Wenn der Handler nicht angegeben ist, entfernen Sie alle Handler für den angegebenen Ereignisnamen.
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>
Geerbt vonReport.off
on<T>(string, IEventHandler<T>)
Fügt einen Ereignishandler für ein bestimmtes Ereignis hinzu.
report.on('pageChanged', (event) => {
console.log('PageChanged: ', event.page.name);
});
function on<T>(eventName: string, handler: IEventHandler<T>)
Parameter
- eventName
-
string
- handler
-
IEventHandler<T>
Geerbt vonReport.on
print()
Gibt die aktive Seite des Berichts durch Aufrufen window.print()
der Komponente "iframe einbetten" aus.
function print(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonReport.print
refresh()
Aktualisiert Datenquellen für den Bericht.
report.refresh();
function refresh(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonReport.refresh
reload()
Lädt die Einbettung mithilfe einer vorhandenen Konfiguration neu. Für Berichte werden z. B. alle Filter gelöscht und die erste Seite aktiviert, die das Zurücksetzen eines Berichts auf den geladenen Zustand simuliert.
report.reload();
function reload(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonReport.reload
removeComponentTabIndex(number)
Entfernt das tabindex-Attribut des Elements.
function removeComponentTabIndex(_tabIndex?: number)
Parameter
- _tabIndex
-
number
Geerbt vonReport.removeComponentTabIndex
removeContextMenuCommand(string, string)
Kontextmenüerweiterungsbefehl entfernen.
report.removeContextMenuCommand(commandName, contextMenuTitle)
.catch(error => {
...
});
function removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Parameter
- commandName
-
string
- contextMenuTitle
-
string
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.removeContextMenuCommand
removeOptionsMenuCommand(string, string)
Menüerweiterungsbefehl "Optionen entfernen".
report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
.then({
...
});
function removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>>
Parameter
- commandName
-
string
- optionsMenuTitle
-
string
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.removeOptionsMenuCommand
renamePage(string, string)
Umbenennen einer Seite aus einem Bericht
// 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
Gibt zurück
Promise<void>
Geerbt vonReport.renamePage
resetPersistentFilters()
Zurücksetzen von Filtern, Slicern und anderen Datenansichtsänderungen des Benutzers auf den Standardzustand des Berichts
report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.resetPersistentFilters
resetTheme()
Zurücksetzen und Anwenden des Standarddesigns des Berichts
report.resetTheme();
function resetTheme(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonReport.resetTheme
resizeActivePage(PageSizeType, number, number)
Aktualisierungen die Größe der aktiven Seite im Bericht.
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
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.resizeActivePage
resizeVisual(string, string, number, number)
Ändern der Größe eines Visuals auf einer Seite.
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
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.resizeVisual
save()
Speichert den Bericht.
function save(): Promise<void>
Gibt zurück
Promise<void>
Geerbt vonReport.save
saveAs(ISaveAsParameters)
SaveAs Report.
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
Parameter
- saveAsParameters
- ISaveAsParameters
Gibt zurück
Promise<void>
Geerbt vonReport.saveAs
savePersistentFilters()
Speichern von Filtern, Datenschnitten und anderen Datenansichtsänderungen des Berichts
report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.savePersistentFilters
setAccessToken(string)
Legen Sie accessToken fest.
function setAccessToken(accessToken: string): Promise<void>
Parameter
- accessToken
-
string
Gibt zurück
Promise<void>
Geerbt vonReport.setAccessToken
setComponentTabIndex(number)
Legt das tabindex-Attribut des Elements fest
function setComponentTabIndex(tabIndex?: number)
Parameter
- tabIndex
-
number
Geerbt vonReport.setComponentTabIndex
setComponentTitle(string)
Legen Sie den Komponententitel für Barrierefreiheit fest. Im Fall von iframes ändert diese Methode den iframe-Titel.
function setComponentTitle(title: string)
Parameter
- title
-
string
Geerbt vonReport.setComponentTitle
setVisualDisplayState(string, string, VisualContainerDisplayMode)
Aktualisierungen den Anzeigezustand eines Visuals auf einer Seite.
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
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.setVisualDisplayState
setZoom(number)
Legt die Zoomstufe des Berichts fest.
function setZoom(zoomLevel: number): Promise<void>
Parameter
- zoomLevel
-
number
Festzulegende Zoomstufe
Gibt zurück
Promise<void>
Geerbt vonReport.setZoom
switchLayout(LayoutType)
Aktualisierungen des Berichtslayouts
report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>
Parameter
- layoutType
- LayoutType
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.switchLayout
switchMode(string | ViewMode)
Wechseln Sie zum Berichtsansichtsmodus.
function switchMode(viewMode: string | ViewMode): Promise<void>
Parameter
- viewMode
-
string | ViewMode
Gibt zurück
Promise<void>
Geerbt vonReport.switchMode
updateSettings(ISettings)
Aktualisierungen Sichtbarkeitseinstellungen für den Filterbereich und den Seitennavigationsbereich.
const newSettings = {
panes: {
filters: {
visible: false
}
}
};
report.updateSettings(newSettings)
.catch(error => { ... });
function updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>>
Parameter
- settings
- ISettings
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
Geerbt vonReport.updateSettings