Freigeben über

QuickCreate class

  • Referenz
Paket:
powerbi-client

Power BI-Schnellerstellungskomponente

Extends

Embed

Konstruktoren

QuickCreate(Service, HTMLElement, IQuickCreateConfiguration, boolean, boolean)

Methoden

getId()

Überschreiben der abstrakten getId-Funktion QuickCreate benötigt keine ID
validate(IEmbedConfigurationBase)

Überprüfen Sie die Erstellung der 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 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 zum Konstruktor

QuickCreate(Service, HTMLElement, IQuickCreateConfiguration, boolean, boolean) 

new QuickCreate(service: Service, element: HTMLElement, config: IQuickCreateConfiguration, phasedRender?: boolean, isBootstrap?: boolean)

Parameter

service
Service
element

HTMLElement

config
IQuickCreateConfiguration
phasedRender

boolean

isBootstrap

boolean

Details zur Methode

getId()

Überschreiben der abstrakten getId-Funktion QuickCreate benötigt keine ID

function getId(): string

Gibt zurück

string

validate(IEmbedConfigurationBase)

Überprüfen Sie die Erstellung der 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 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