QuickCreate class

Paket:: powerbi-client

En snabbskapningskomponent för Power BI

Extends: Embed

Konstruktorer

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

Metoder

getId()	Åsidosätt den abstrakta funktionen getId QuickCreate behöver inget ID
validate(IEmbedConfigurationBase)	Verifiera konfigurationen av skapa rapport.

Ärvda metoder

exitFullscreen()	Begär att webbläsaren avslutar fullskärmsläget.
fullscreen()	Begär att webbläsaren ska återge komponentens iframe i fullskärmsläge.
getCorrelationId()	Hämta correlationId för den aktuella inbäddningssessionen. `// Get the correlationId for the current embed session report.getCorrelationId() .then(correlationId => { ... });`
off<T>(string, IEventHandler<T>)	Tar bort en eller flera händelsehanterare från listan över hanterare. Om en referens till den befintliga referensfunktionen har angetts tar du bort den specifika hanteraren. Om hanteraren inte har angetts tar du bort alla hanterare för det angivna händelsenamnet. `report.off('pageChanged') or const logHandler = function (event) { console.log(event); }; report.off('pageChanged', logHandler);`
on<T>(string, IEventHandler<T>)	Lägger till en händelsehanterare för en viss händelse. `report.on('pageChanged', (event) => { console.log('PageChanged: ', event.page.name); });`
reload()	Läser in inbäddningen igen med hjälp av befintlig konfiguration. T.ex. För rapporter rensar detta effektivt alla filter och gör den första sidan aktiv som simulerar återställning av en rapport tillbaka till inläst tillstånd. `report.reload();`
removeComponentTabIndex(number)	Tar bort elementets tabindexattribut
save()	Sparar rapport.
saveAs(ISaveAsParameters)	SaveAs-rapport.
setAccessToken(string)	Ange accessToken.
setComponentTabIndex(number)	Anger elementets tabindexattribut
setComponentTitle(string)	Ange komponentrubriken för hjälpmedel. Om det gäller iframes ändrar den här metoden iframe-rubriken.

Konstruktorinformation

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

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

Parametrar

service: Service

element: HTMLElement

config: IQuickCreateConfiguration

phasedRender: boolean

isBootstrap: boolean

Metodinformation

getId()

Åsidosätt den abstrakta funktionen getId QuickCreate behöver inget ID

function getId(): string

Returer

string

validate(IEmbedConfigurationBase)

Verifiera konfigurationen av skapa rapport.

function validate(config: IEmbedConfigurationBase): IError[]

Parametrar

config: IEmbedConfigurationBase

Returer

IError[]

Ärvd metodinformation

exitFullscreen()

Begär att webbläsaren avslutar fullskärmsläget.

function exitFullscreen()

ärvd från Embed.exitFullscreen

fullscreen()

Begär att webbläsaren ska återge komponentens iframe i fullskärmsläge.

function fullscreen()

ärvd från Embed.fullscreen

getCorrelationId()

Hämta correlationId för den aktuella inbäddningssessionen.

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });

function getCorrelationId(): Promise<string>

Returer

Promise<string>

ärvd från Embed.getCorrelationId

off<T>(string, IEventHandler<T>)

Tar bort en eller flera händelsehanterare från listan över hanterare. Om en referens till den befintliga referensfunktionen har angetts tar du bort den specifika hanteraren. Om hanteraren inte har angetts tar du bort alla hanterare för det angivna händelsenamnet.

report.off('pageChanged')

or

const logHandler = function (event) {
   console.log(event);
};

report.off('pageChanged', logHandler);

function off<T>(eventName: string, handler?: IEventHandler<T>)

Parametrar

eventName: string

handler: IEventHandler<T>

ärvd från Embed.off

on<T>(string, IEventHandler<T>)

Lägger till en händelsehanterare för en viss händelse.

report.on('pageChanged', (event) => {
  console.log('PageChanged: ', event.page.name);
});

function on<T>(eventName: string, handler: IEventHandler<T>)

Parametrar

eventName: string

handler: IEventHandler<T>

ärvd från Embed.on

reload()

Läser in inbäddningen igen med hjälp av befintlig konfiguration. T.ex. För rapporter rensar detta effektivt alla filter och gör den första sidan aktiv som simulerar återställning av en rapport tillbaka till inläst tillstånd.

report.reload();

function reload(): Promise<void>

Returer

Promise<void>

ärvd från Embed.reload

removeComponentTabIndex(number)

Tar bort elementets tabindexattribut

function removeComponentTabIndex(_tabIndex?: number)

Parametrar

_tabIndex: number

ärvd från Embed.removeComponentTabIndex

save()

Sparar rapport.

function save(): Promise<void>

Returer

Promise<void>

ärvd från Embed.save

saveAs(ISaveAsParameters)

SaveAs-rapport.

function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>

Parametrar

saveAsParameters: ISaveAsParameters

Returer

Promise<void>

ärvs från Embed.saveAs

setAccessToken(string)

Ange accessToken.

function setAccessToken(accessToken: string): Promise<void>

Parametrar

accessToken: string

Returer

Promise<void>

ärvd från Embed.setAccessToken

setComponentTabIndex(number)

Anger elementets tabindexattribut

function setComponentTabIndex(tabIndex?: number)

Parametrar

tabIndex: number

ärvd från Embed.setComponentTabIndex

setComponentTitle(string)

Ange komponentrubriken för hjälpmedel. Om det gäller iframes ändrar den här metoden iframe-rubriken.

function setComponentTitle(title: string)

Parametrar

title: string

ärvd från Embed.setComponentTitle