Report class
Die Power BI-Berichtseinbettungskomponente
- Extends
-
Embed
Eigenschaften
bookmarks |
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 auf den Bericht Filter, Datenschnitte oder andere Datenansichtsänderungen angewendet werden. Wenn persistente Filter deaktiviert sind, wird "false" zurückgegeben.
|
clear |
Löscht ausgewählte visuelle Elemente, die nicht angezeigt werden, wenn die Kennzeichnung übergeben wird, werden alle visuellen 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
|
get |
Ruft die aktive Berichtsseite ab.
|
get |
Ruft Filter ab, die auf Berichtsebene angewendet werden.
|
get |
Ruft die Berichts-ID vom ersten verfügbaren Speicherort ab: Optionen, Attribut, Einbettungs-URL. |
get |
Ruft eine Berichtsseite anhand des Namens ab.
|
get |
Ruft die Liste der Seiten innerhalb des Berichts ab.
|
get |
Abrufen des Designs des Berichts
|
get |
Gibt den aktuellen Zoomfaktor des Berichts zurück. |
is |
überprüft, ob der Bericht gespeichert wird.
|
move |
Aktualisiert die Position eines visuellen Elements auf einer Seite.
|
print() | Druckt die aktive Seite des Berichts, indem sie |
refresh() | Aktualisiert Datenquellen für den Bericht.
|
remove |
Befehl "Kontextmenüerweiterung entfernen".
|
remove |
Entfernt alle Filter auf Berichtsebene.
|
remove |
Menüerweiterungsbefehl "Optionen entfernen".
|
rename |
Umbenennen einer Seite aus einem Bericht
|
render(IReport |
Rendern eines vorab geladenen Berichts mithilfe der phasenweisen Einbettungs-API
|
reset |
Zurücksetzen der Filter, Datenschnitte und anderer Datenansichtsänderungen des Benutzers auf den Standardzustand des Berichts
|
reset |
Zurücksetzen und Anwenden des Standarddesigns des Berichts
|
resize |
Aktualisiert die Größe der aktiven Seite im Bericht.
|
resize |
Ändern Sie die Größe eines visuellen Elements auf einer Seite.
|
save |
Speichern der Filter, Datenschnitte und anderer Datenansichtsänderungen des Berichts
|
set |
Legt Filter auf Berichtsebene fest.
|
set |
Legt die aktive Seite des Berichts fest.
|
set |
Aktualisiert den Anzeigezustand eines visuellen Elements auf einer Seite.
|
set |
Legt den Zoomfaktor des Berichts fest. |
switch |
Aktualisiert das Berichtslayout.
|
switch |
Wechseln des Berichtsansichtsmodus. |
update |
Aktualisieren Sie die Filter auf Berichtsebene gemäß dem Vorgang: Hinzufügen, Ersetzen aller, Ersetzen durch Ziel oder Entfernen.
|
update |
Aktualisiert die Sichtbarkeitseinstellungen für den Filterbereich und den Seitennavigationsbereich.
|
Geerbte Methoden
exit |
Fordert den Browser auf, den Vollbildmodus zu beenden. |
fullscreen() | Fordert den Browser auf, den iFrame der Komponente im Vollbildmodus zu rendern. |
get |
Rufen Sie die Korrelations-ID für die aktuelle Einbettungssitzung ab.
|
off<T>(string, IEvent |
Entfernt einen oder mehrere Ereignishandler aus der Liste der Handler. Wenn ein Verweis auf die vorhandene Handle-Funktion angegeben ist, 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.
|
reload() | Lädt das Einbetten mithilfe einer vorhandenen Konfiguration neu. Für Berichte werden dadurch beispielsweise alle Filter effektiv gelöscht und die erste Seite aktiv, die das Zurücksetzen eines Berichts auf den geladenen Zustand simuliert.
|
remove |
Entfernt das Tabindex-Attribut des Elements. |
save() | Speichert den Bericht. |
save |
SaveAs-Bericht. |
set |
Legen Sie accessToken fest. |
set |
Tabindex-Attribut des Sets-Elements |
set |
Legen Sie den Komponententitel für Barrierefreiheit fest. Bei iframes ändert diese Methode den iframe-Titel. |
Details zur Eigenschaft
bookmarksManager
Details zur 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>>
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>>
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>
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>
arePersistentFiltersApplied()
Gibt zurück, wenn auf den Bericht Filter, Datenschnitte oder andere Datenansichtsänderungen angewendet werden. Wenn persistente Filter deaktiviert sind, wird "false" zurückgegeben.
report.arePersistentFiltersApplied();
function arePersistentFiltersApplied(): Promise<boolean>
Gibt zurück
Promise<boolean>
clearSelectedVisuals(boolean)
Löscht ausgewählte visuelle Elemente, die nicht angezeigt werden, wenn die Kennzeichnung übergeben wird, werden alle visuellen Auswahlen gelöscht.
report.clearSelectedVisuals()
.then(() => {
...
});
function clearSelectedVisuals(clearPopOutState?: boolean): Promise<void>
Parameter
- clearPopOutState
-
boolean
Wenn die Auswahl falsch/nicht definierter visueller Elemente nicht gelöscht wird, wenn sich ein visueller Bereich im Ausblendezustand befindet (im Fokus, als Tabelle anzeigen, Spotlight...)
Gibt zurück
Promise<void>
closeAllOverlays()
Schließt alle geöffneten Kontextmenüs und QuickInfos.
report.closeAllOverlays()
.then(() => {
...
});
function closeAllOverlays(): Promise<void>
Gibt zurück
Promise<void>
configChanged(boolean)
Behandeln von Konfigurationsänderungen.
function configChanged(isBootstrap: boolean)
Parameter
- isBootstrap
-
boolean
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>
getActivePage()
Ruft die aktive Berichtsseite ab.
report.getActivePage()
.then(activePage => {
...
});
function getActivePage(): Promise<Page>
Gibt zurück
Promise<Page>
getFilters()
Ruft Filter ab, die auf Berichtsebene angewendet werden.
// Get filters applied at report level
report.getFilters()
.then(filters => {
...
});
function getFilters(): Promise<IFilter[]>
Gibt zurück
Promise<IFilter[]>
getId()
Ruft die Berichts-ID vom ersten verfügbaren Speicherort ab: Optionen, Attribut, Einbettungs-URL.
function getId(): string
Gibt zurück
string
getPageByName(string)
Ruft eine Berichtsseite anhand des Namens ab.
report.getPageByName(pageName)
.then(page => {
...
});
function getPageByName(pageName: string): Promise<Page>
Parameter
- pageName
-
string
Gibt zurück
Promise<Page>
getPages()
Ruft die Liste der Seiten innerhalb des Berichts ab.
report.getPages()
.then(pages => {
...
});
function getPages(): Promise<Page[]>
Gibt zurück
Promise<Page[]>
getTheme()
Abrufen des Designs des Berichts
report.getTheme();
function getTheme(): Promise<IReportTheme>
Gibt zurück
Promise<IReportTheme>
getZoom()
Gibt den aktuellen Zoomfaktor des Berichts zurück.
function getZoom(): Promise<number>
Gibt zurück
Promise<number>
isSaved()
überprüft, ob der Bericht gespeichert wird.
report.isSaved()
function isSaved(): Promise<boolean>
Gibt zurück
Promise<boolean>
moveVisual(string, string, number, number, number)
Aktualisiert die Position eines visuellen Elements 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>>
print()
Druckt die aktive Seite des Berichts, indem sie window.print()
in die Komponente "iframe einbetten" aufruft.
function print(): Promise<void>
Gibt zurück
Promise<void>
refresh()
Aktualisiert Datenquellen für den Bericht.
report.refresh();
function refresh(): Promise<void>
Gibt zurück
Promise<void>
removeContextMenuCommand(string, string)
Befehl "Kontextmenüerweiterung 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>>
removeFilters()
Entfernt alle Filter auf Berichtsebene.
report.removeFilters();
function removeFilters(): Promise<IHttpPostMessageResponse<void>>
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
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>>
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>
render(IReportEmbedConfiguration | IReportLoadConfiguration)
Rendern eines vorab geladenen Berichts mithilfe der phasenweisen Einbettungs-API
// Load report
var report = powerbi.load(element, config);
...
// Render report
report.render()
function render(config?: IReportEmbedConfiguration | IReportLoadConfiguration): Promise<void>
Parameter
Gibt zurück
Promise<void>
resetPersistentFilters()
Zurücksetzen der Filter, Datenschnitte und anderer Datenansichtsänderungen des Benutzers auf den Standardzustand des Berichts
report.resetPersistentFilters();
function resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
resetTheme()
Zurücksetzen und Anwenden des Standarddesigns des Berichts
report.resetTheme();
function resetTheme(): Promise<void>
Gibt zurück
Promise<void>
resizeActivePage(PageSizeType, number, number)
Aktualisiert 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>>
resizeVisual(string, string, number, number)
Ändern Sie die Größe eines visuellen Elements 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>>
savePersistentFilters()
Speichern der Filter, Datenschnitte und anderer Datenansichtsänderungen des Berichts
report.savePersistentFilters();
function savePersistentFilters(): Promise<IHttpPostMessageResponse<void>>
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
setFilters(IFilter[])
Legt Filter auf Berichtsebene fest.
const filters: [
...
];
report.setFilters(filters)
.catch(errors => {
...
});
function setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>
Parameter
- filters
-
IFilter[]
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
setPage(string)
Legt die aktive Seite des Berichts fest.
report.setPage("page2")
.catch(error => { ... });
function setPage(pageName: string): Promise<IHttpPostMessageResponse<void>>
Parameter
- pageName
-
string
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
setVisualDisplayState(string, string, VisualContainerDisplayMode)
Aktualisiert den Anzeigezustand eines visuellen Elements 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>>
setZoom(number)
Legt den Zoomfaktor des Berichts fest.
function setZoom(zoomLevel: number): Promise<void>
Parameter
- zoomLevel
-
number
Festzulegende Zoomstufe
Gibt zurück
Promise<void>
switchLayout(LayoutType)
Aktualisiert das Berichtslayout.
report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>
Parameter
- layoutType
- LayoutType
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
switchMode(string | ViewMode)
Wechseln des Berichtsansichtsmodus.
function switchMode(viewMode: string | ViewMode): Promise<void>
Parameter
- viewMode
-
string | ViewMode
Gibt zurück
Promise<void>
updateFilters(FiltersOperations, IFilter[])
Aktualisieren Sie die Filter auf Berichtsebene gemäß dem Vorgang: Hinzufügen, Ersetzen aller, Ersetzen durch Ziel oder Entfernen.
report.updateFilters(FiltersOperations.Add, filters)
.catch(errors => { ... });
function updateFilters(operation: FiltersOperations, filters?: IFilter[]): Promise<IHttpPostMessageResponse<void>>
Parameter
- operation
- FiltersOperations
- filters
-
IFilter[]
Gibt zurück
Promise<IHttpPostMessageResponse<void>>
updateSettings(ISettings)
Aktualisiert die 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>>
Details zur geerbten Methode
exitFullscreen()
Fordert den Browser auf, den Vollbildmodus zu beenden.
function exitFullscreen()
geerbt von Embed.exitFullscreen
fullscreen()
Fordert den Browser auf, den iFrame der Komponente im Vollbildmodus zu rendern.
function fullscreen()
Geerbt von Embed.fullscreen
getCorrelationId()
Rufen Sie die Korrelations-ID 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 von Embed.getCorrelationId
off<T>(string, IEventHandler<T>)
Entfernt einen oder mehrere Ereignishandler aus der Liste der Handler. Wenn ein Verweis auf die vorhandene Handle-Funktion angegeben ist, 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 von Embed.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 von Embed.on
reload()
Lädt das Einbetten mithilfe einer vorhandenen Konfiguration neu. Für Berichte werden dadurch beispielsweise alle Filter effektiv gelöscht und die erste Seite aktiv, die das Zurücksetzen eines Berichts auf den geladenen Zustand simuliert.
report.reload();
function reload(): Promise<void>
Gibt zurück
Promise<void>
geerbt von Embed.reload
removeComponentTabIndex(number)
Entfernt das Tabindex-Attribut des Elements.
function removeComponentTabIndex(_tabIndex?: number)
Parameter
- _tabIndex
-
number
geerbt von Embed.removeComponentTabIndex
save()
Speichert den Bericht.
function save(): Promise<void>
Gibt zurück
Promise<void>
Geerbt von Embed.save
saveAs(ISaveAsParameters)
SaveAs-Bericht.
function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>
Parameter
- saveAsParameters
- ISaveAsParameters
Gibt zurück
Promise<void>
Geerbt von Embed.saveAs
setAccessToken(string)
Legen Sie accessToken fest.
function setAccessToken(accessToken: string): Promise<void>
Parameter
- accessToken
-
string
Gibt zurück
Promise<void>
Geerbt von Embed.setAccessToken
setComponentTabIndex(number)
Tabindex-Attribut des Sets-Elements
function setComponentTabIndex(tabIndex?: number)
Parameter
- tabIndex
-
number
Geerbt von Embed.setComponentTabIndex
setComponentTitle(string)
Legen Sie den Komponententitel für Barrierefreiheit fest. Bei iframes ändert diese Methode den iframe-Titel.
function setComponentTitle(title: string)
Parameter
- title
-
string
Geerbt von Embed.setComponentTitle