Service class

Paket:

powerbi-client

Die Einbettungskomponente des Power BI-Diensts, die der Einstiegspunkt zum Einbetten aller anderen Power BI-Komponenten in Ihre Anwendung ist

Eigenschaften

router

Methoden

bootstrap(HTMLElement, IBootstrapEmbedConfiguration | IComponentEmbedConfiguration)	Erstellt bei Einem HTML-Element und entityType eine neue Komponenteninstanz, und bootstrapt den iframe für die Einbettung.
createReport(HTMLElement, IEmbedConfiguration | IReportCreateConfiguration)	Erstellt einen neuen Bericht
embed(HTMLElement, IEmbedConfigurationBase | IComponentEmbedConfiguration)	Wenn die Komponente bereits erstellt und an das Element angefügt wurde, wird bei einer Konfiguration, die auf einem HTML-Element basiert, die Komponenteninstanz und den vorhandenen iframe wiederverwendet, andernfalls eine neue Komponenteninstanz erstellt.
get(HTMLElement)	Gibt eine Instanz der Komponente zurück, die dem -Element zugeordnet ist.
invokeSDKHook(Function, IExtendedRequest, Response)
load(HTMLElement, IEmbedConfigurationBase | IComponentEmbedConfiguration)	Wenn die Komponente bereits erstellt und an das Element angefügt wurde, wird bei einer Konfiguration, die auf einem HTML-Element basiert, die Komponenteninstanz und den vorhandenen iframe wiederverwendet, andernfalls eine neue Komponenteninstanz erstellt. Dies wird für die PHASENeinbettungs-API verwendet. Sobald das Element erfolgreich geladen wurde, kann man "rendern" darauf aufrufen.
preload(IEmbedConfigurationBase | IComponentEmbedConfiguration, HTMLElement)	API für eingebettete Powerbi-Endpunkte mit warmer Startphase. Verwenden Sie diese API, um Power BI Embedded im Hintergrund vorab zu laden.
quickCreate(HTMLElement, IQuickCreateConfiguration)	Erstellt ein neues Dataset
reset(HTMLElement)	Bei einem HTML-Element, in das eine Komponente eingebettet ist, wird die Komponente aus der Liste der eingebetteten Komponenten entfernt, die Zuordnung zwischen dem Element und der Komponente entfernt und der iframe entfernt.

Details zur Eigenschaft

router

router: Router

Eigenschaftswert

Router

Details zur Methode

bootstrap(HTMLElement, IBootstrapEmbedConfiguration | IComponentEmbedConfiguration)

Erstellt bei Einem HTML-Element und entityType eine neue Komponenteninstanz, und bootstrapt den iframe für die Einbettung.

function bootstrap(element: HTMLElement, config: IBootstrapEmbedConfiguration | IComponentEmbedConfiguration): Embed

Parameter

element

HTMLElement

config

IBootstrapEmbedConfiguration | IComponentEmbedConfiguration

Gibt zurück

Embed

createReport(HTMLElement, IEmbedConfiguration | IReportCreateConfiguration)

Erstellt einen neuen Bericht

function createReport(element: HTMLElement, config?: IEmbedConfiguration | IReportCreateConfiguration): Embed

Parameter

element

HTMLElement

config

IEmbedConfiguration | IReportCreateConfiguration

Gibt zurück

Embed

embed(HTMLElement, IEmbedConfigurationBase | IComponentEmbedConfiguration)

Wenn die Komponente bereits erstellt und an das Element angefügt wurde, wird bei einer Konfiguration, die auf einem HTML-Element basiert, die Komponenteninstanz und den vorhandenen iframe wiederverwendet, andernfalls eine neue Komponenteninstanz erstellt.

function embed(element: HTMLElement, config?: IEmbedConfigurationBase | IComponentEmbedConfiguration): Embed

Parameter

element

HTMLElement

config

IEmbedConfigurationBase | IComponentEmbedConfiguration

Gibt zurück

Embed

get(HTMLElement)

Gibt eine Instanz der Komponente zurück, die dem -Element zugeordnet ist.

function get(element: HTMLElement): Embed

Parameter

element

HTMLElement

Gibt zurück

Embed

invokeSDKHook(Function, IExtendedRequest, Response)

function invokeSDKHook(hook: Function, req: IExtendedRequest, res: Response): Promise<void>

Parameter

hook

Function

req

IExtendedRequest

res

Response

Gibt zurück

Promise<void>

load(HTMLElement, IEmbedConfigurationBase | IComponentEmbedConfiguration)

Wenn die Komponente bereits erstellt und an das Element angefügt wurde, wird bei einer Konfiguration, die auf einem HTML-Element basiert, die Komponenteninstanz und den vorhandenen iframe wiederverwendet, andernfalls eine neue Komponenteninstanz erstellt. Dies wird für die PHASENeinbettungs-API verwendet. Sobald das Element erfolgreich geladen wurde, kann man "rendern" darauf aufrufen.

function load(element: HTMLElement, config?: IEmbedConfigurationBase | IComponentEmbedConfiguration): Embed

Parameter

element

HTMLElement

config

IEmbedConfigurationBase | IComponentEmbedConfiguration

Gibt zurück

Embed

preload(IEmbedConfigurationBase | IComponentEmbedConfiguration, HTMLElement)

API für eingebettete Powerbi-Endpunkte mit warmer Startphase. Verwenden Sie diese API, um Power BI Embedded im Hintergrund vorab zu laden.

function preload(config?: IEmbedConfigurationBase | IComponentEmbedConfiguration, element?: HTMLElement): HTMLIFrameElement

Parameter

config

IEmbedConfigurationBase | IComponentEmbedConfiguration

element

HTMLElement

Gibt zurück

HTMLIFrameElement

quickCreate(HTMLElement, IQuickCreateConfiguration)

Erstellt ein neues Dataset

function quickCreate(element: HTMLElement, config?: IQuickCreateConfiguration): Embed

Parameter

element

HTMLElement

config

IQuickCreateConfiguration

Gibt zurück

Embed

reset(HTMLElement)

Bei einem HTML-Element, in das eine Komponente eingebettet ist, wird die Komponente aus der Liste der eingebetteten Komponenten entfernt, die Zuordnung zwischen dem Element und der Komponente entfernt und der iframe entfernt.

function reset(element: HTMLElement)

Parameter

element

HTMLElement