Freigeben über

Create class

  • Referenz
Paket:
powerbi-client

Erstellen einer Power BI-Berichtskomponente

Extends

Embed

Konstruktoren

Create(Service, HTMLElement, IEmbedConfiguration | IReportCreateConfiguration, boolean, boolean)

Methoden

getId()

Ruft die Dataset-ID vom ersten verfügbaren Speicherort ab: createConfig oder Einbettungs-URL.
isSaved()

überprüft, ob der Bericht gespeichert wird.

report.isSaved()
validate(IEmbedConfigurationBase)

Überprüfen sie die Berichtskonfiguration.

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 Korrelations-ID 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 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);
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 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();
removeComponentTabIndex(number)

Entfernt das Tabindex-Attribut des Elements.
save()

Speichert den Bericht.
saveAs(ISaveAsParameters)

SaveAs-Bericht.
setAccessToken(string)

Legen Sie accessToken fest.
setComponentTabIndex(number)

Tabindex-Attribut des Sets-Elements
setComponentTitle(string)

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

Details zum Konstruktor

Create(Service, HTMLElement, IEmbedConfiguration | IReportCreateConfiguration, boolean, boolean) 

new Create(service: Service, element: HTMLElement, config: IEmbedConfiguration | IReportCreateConfiguration, phasedRender?: boolean, isBootstrap?: boolean)

Parameter

service
Service
element

HTMLElement

config

IEmbedConfiguration | IReportCreateConfiguration

phasedRender

boolean

isBootstrap

boolean

Details zur Methode

getId()

Ruft die Dataset-ID vom ersten verfügbaren Speicherort ab: createConfig oder Einbettungs-URL.

function getId(): string

Gibt zurück

string

isSaved()

überprüft, ob der Bericht gespeichert wird.

report.isSaved()

function isSaved(): Promise<boolean>

Gibt zurück

Promise<boolean>

validate(IEmbedConfigurationBase)

Überprüfen sie die Berichtskonfiguration.

function validate(config: IEmbedConfigurationBase): IError[]

Parameter

config
IEmbedConfigurationBase

Gibt zurück

IError[]

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