Share via


Report class

Einbettungskomponente für Power BI-Berichte

Extends

Embed

Eigenschaften

bookmarksManager

Methoden

addContextMenuCommand(string, string, string, MenuLocation, string, string, string)

Hinzufügen des Kontextmenüerweiterungsbefehls.

report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName)
 .catch(error => {
     ...
 });
addOptionsMenuCommand(string, string, string, MenuLocation, string, string, string, string)

Menüerweiterungsbefehl hinzufügen.

report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon)
 .catch(error => {
     ...
 });
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");
applyTheme(IReportTheme)

Anwenden eines Designs auf den Bericht

report.applyTheme(theme);
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();
clearSelectedVisuals(boolean)

Löscht ausgewählte nicht aufgekloppte Visuals. Wenn das Flag übergeben wird, werden alle Visuals-Auswahlen gelöscht.

report.clearSelectedVisuals()
 .then(() => {
     ...
 });
closeAllOverlays()

Schließt alle geöffneten Kontextmenüs und QuickInfos.

report.closeAllOverlays()
 .then(() => {
     ...
 });
configChanged(boolean)

Behandeln sie Konfigurationsänderungen.

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");
getActivePage()

Ruft die aktive Berichtsseite ab.

report.getActivePage()
 .then(activePage => {
     ...
 });
getFilters()

Ruft Filter ab, die auf Berichtsebene angewendet werden.

// Get filters applied at report level
report.getFilters()
  .then(filters => {
    ...
  });
getId()

Ruft die Berichts-ID vom ersten verfügbaren Speicherort ab: Optionen, Attribut, Einbettungs-URL.

getPageByName(string)

Ruft eine Berichtsseite nach ihrem Namen ab.

report.getPageByName(pageName)
 .then(page => {
     ...
 });
getPages()

Ruft die Liste der Seiten innerhalb des Berichts ab.

report.getPages()
 .then(pages => {
     ...
 });
getTheme()

Abrufen des Designs des Berichts

report.getTheme();
getZoom()

Gibt die aktuelle Zoomstufe des Berichts zurück.

isSaved()

überprüft, ob der Bericht gespeichert ist.

report.isSaved()
moveVisual(string, string, number, number, number)

Aktualisierungen die Position eines Visuals auf einer Seite.

report.moveVisual(pageName, visualName, x, y, z)
  .catch(error => { ... });
print()

Gibt die aktive Seite des Berichts aus, indem window.print() die Komponente "iframe einbetten" aufgerufen wird.

refresh()

Aktualisiert Datenquellen für den Bericht.

report.refresh();
removeContextMenuCommand(string, string)

Kontextmenüerweiterungsbefehl entfernen.

report.removeContextMenuCommand(commandName, contextMenuTitle)
 .catch(error => {
     ...
 });
removeFilters()

Entfernt alle Filter auf Berichtsebene.

report.removeFilters();
removeOptionsMenuCommand(string, string)

Menüerweiterungsbefehl für Optionen entfernen.

report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
 .then({
     ...
 });
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");
render(IReportEmbedConfiguration | IReportLoadConfiguration)

Rendern eines vorab geladenen Berichts mithilfe der API für die schrittweise Einbettung

// Load report
var report = powerbi.load(element, config);

...

// Render report
report.render()
resetPersistentFilters()

Zurücksetzen von Filtern, Datenschnitten und anderen Datenansichtsänderungen des Benutzers auf den Standardzustand des Berichts

report.resetPersistentFilters();
resetTheme()

Zurücksetzen und Anwenden des Standarddesigns des Berichts

report.resetTheme();
resizeActivePage(PageSizeType, number, number)

Aktualisierungen die Größe der aktiven Seite im Bericht.

report.resizeActivePage(pageSizeType, width, height)
  .catch(error => { ... });
resizeVisual(string, string, number, number)

Ändern Sie die Größe eines Visuals auf einer Seite.

report.resizeVisual(pageName, visualName, width, height)
  .catch(error => { ... });
savePersistentFilters()

Speichern von Filtern, Datenschnitten und anderen Datenansichtsänderungen des Berichts

report.savePersistentFilters();
setFilters(IFilter[])

Legt Filter auf Berichtsebene fest.

const filters: [
   ...
];

report.setFilters(filters)
 .catch(errors => {
   ...
 });
setPage(string)

Legt die aktive Seite des Berichts fest.

report.setPage("page2")
 .catch(error => { ... });
setVisualDisplayState(string, string, VisualContainerDisplayMode)

Aktualisierungen den Anzeigezustand eines Visuals auf einer Seite.

report.setVisualDisplayState(pageName, visualName, displayState)
  .catch(error => { ... });
setZoom(number)

Legt die Zoomstufe des Berichts fest.

switchLayout(LayoutType)

Aktualisierungen des Berichtslayouts

report.switchLayout(layoutType);
switchMode(string | ViewMode)

Wechseln Sie zum Berichtsansichtsmodus.

updateFilters(FiltersOperations, IFilter[])

Aktualisieren Sie die Filter auf Berichtsebene entsprechend dem Vorgang: Hinzufügen, Ersetzen sie alle, Ersetzen durch Ziel oder Entfernen.

report.updateFilters(FiltersOperations.Add, filters)
  .catch(errors => { ... });
updateSettings(ISettings)

Aktualisierungen Sichtbarkeitseinstellungen für den Filterbereich und den Seitennavigationsbereich.

const newSettings = {
  panes: {
    filters: {
      visible: false
    }
  }
};

report.updateSettings(newSettings)
  .catch(error => { ... });

Geerbte Methoden

exitFullscreen()

Fordert den Browser auf, den Vollbildmodus zu beenden.

fullscreen()

Fordert den Browser auf, den Iframe der Komponente im Vollbildmodus zu rendern.

getCorrelationId()

Rufen Sie die correlationId für die aktuelle Einbettungssitzung ab.

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });
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);
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);
});
reload()

Lädt die Einbettung mithilfe der vorhandenen Konfiguration neu. Für Berichte löscht dies z. B. effektiv alle Filter und macht die erste Seite aktiv, wodurch das Zurücksetzen eines Berichts auf den geladenen Zustand simuliert wird.

report.reload();
removeComponentTabIndex(number)

Entfernt das tabindex-Attribut des Elements

save()

Speichert den Bericht.

saveAs(ISaveAsParameters)

SaveAs Report.

setAccessToken(string)

Legen Sie accessToken fest.

setComponentTabIndex(number)

Legt das tabindex-Attribut des Elements fest

setComponentTitle(string)

Legen Sie den Komponententitel für Barrierefreiheit fest. Im Fall von iframes ändert diese Methode den iframe-Titel.

Details zur Eigenschaft

bookmarksManager

bookmarksManager: BookmarksManager

Eigenschaftswert

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 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 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>

clearSelectedVisuals(boolean)

Löscht ausgewählte nicht aufgekloppte 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 die Auswahl von false/undefined visuals nicht gelöscht wird, wenn sich eines der Visuals im Popupzustand 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 sie 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 nach ihrem Namen 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 die aktuelle Zoomstufe des Berichts zurück.

function getZoom(): Promise<number>

Gibt zurück

Promise<number>

isSaved()

überprüft, ob der Bericht gespeichert ist.

report.isSaved()
function isSaved(): Promise<boolean>

Gibt zurück

Promise<boolean>

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>>

print()

Gibt die aktive Seite des Berichts aus, indem window.print() die Komponente "iframe einbetten" aufgerufen wird.

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)

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>>

removeFilters()

Entfernt alle Filter auf Berichtsebene.

report.removeFilters();
function removeFilters(): Promise<IHttpPostMessageResponse<void>>

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

removeOptionsMenuCommand(string, string)

Menüerweiterungsbefehl für 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 API für die schrittweise Einbettung

// 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 von Filtern, Datenschnitten und anderen 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)

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>>

resizeVisual(string, string, number, number)

Ändern Sie die 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>>

savePersistentFilters()

Speichern von Filtern, Datenschnitten und anderen 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)

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

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setZoom(number)

Legt die Zoomstufe des Berichts fest.

function setZoom(zoomLevel: number): Promise<void>

Parameter

zoomLevel

number

Festzulegende Zoomstufe

Gibt zurück

Promise<void>

switchLayout(LayoutType)

Aktualisierungen des Berichtslayouts

report.switchLayout(layoutType);
function switchLayout(layoutType: LayoutType): Promise<IHttpPostMessageResponse<void>>

Parameter

layoutType
LayoutType

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

switchMode(string | ViewMode)

Wechseln Sie zum 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 entsprechend dem Vorgang: Hinzufügen, Ersetzen sie alle, 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)

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>>

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 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 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 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 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 die Einbettung mithilfe der vorhandenen Konfiguration neu. Für Berichte löscht dies z. B. effektiv alle Filter und macht die erste Seite aktiv, wodurch das Zurücksetzen eines Berichts auf den geladenen Zustand simuliert wird.

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 Report.

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)

Legt das tabindex-Attribut des Elements fest

function setComponentTabIndex(tabIndex?: number)

Parameter

tabIndex

number

Geerbt von Embed.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 von Embed.setComponentTitle