Condividi tramite

QuickCreate class

  • Riferimento
Pacchetto:
powerbi-client

Un componente di creazione rapida di Power BI

Extends

Embed

Costruttori

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

Metodi

getId()

Eseguire l'override della funzione astratta getId QuickCreate non richiede alcun ID
validate(IEmbedConfigurationBase)

Convalidare la configurazione di creazione del report.

Metodi ereditati

exitFullscreen()

Richiede al browser di uscire dalla modalità schermo intero.
fullscreen()

Richiede al browser di eseguire il rendering dell'iframe del componente in modalità schermo intero.
getCorrelationId()

Ottenere il correlationId per la sessione di incorporamento corrente.

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });
off<T>(string, IEventHandler<T>)

Rimuove uno o più gestori eventi dall'elenco dei gestori. Se viene specificato un riferimento alla funzione handle esistente, rimuovere il gestore specifico. Se il gestore non è specificato, rimuovere tutti i gestori per il nome dell'evento specificato.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);
on<T>(string, IEventHandler<T>)

Aggiunge un gestore eventi per un evento specifico.

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

Ricarica l'incorporamento usando la configurazione esistente. Ad esempio, per i report questo cancella efficacemente tutti i filtri e rende attiva la prima pagina che simula la reimpostazione di un report sullo stato caricato.

report.reload();
removeComponentTabIndex(number)

Rimuove l'attributo tabindex dell'elemento
save()

Salva report.
saveAs(ISaveAsParameters)

SaveAs Report.
setAccessToken(string)

Impostare accessToken.
setComponentTabIndex(number)

Imposta l'attributo tabindex dell'elemento
setComponentTitle(string)

Impostare il titolo del componente per l'accessibilità. In caso di iframe, questo metodo modificherà il titolo dell'iframe.

Dettagli costruttore

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

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

Parametri

service
Service
element

HTMLElement

config
IQuickCreateConfiguration
phasedRender

boolean

isBootstrap

boolean

Dettagli metodo

getId()

Eseguire l'override della funzione astratta getId QuickCreate non richiede alcun ID

function getId(): string

Restituisce

string

validate(IEmbedConfigurationBase)

Convalidare la configurazione di creazione del report.

function validate(config: IEmbedConfigurationBase): IError[]

Parametri

config
IEmbedConfigurationBase

Restituisce

IError[]

Dettagli dei metodi ereditati

exitFullscreen()

Richiede al browser di uscire dalla modalità schermo intero.

function exitFullscreen()

Ereditato da Embed.exitFullscreen

fullscreen()

Richiede al browser di eseguire il rendering dell'iframe del componente in modalità schermo intero.

function fullscreen()

ereditato da Embed.fullscreen

getCorrelationId()

Ottenere il correlationId per la sessione di incorporamento corrente.

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

function getCorrelationId(): Promise<string>

Restituisce

Promise<string>

Ereditato da Embed.getCorrelationId

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

Rimuove uno o più gestori eventi dall'elenco dei gestori. Se viene specificato un riferimento alla funzione handle esistente, rimuovere il gestore specifico. Se il gestore non è specificato, rimuovere tutti i gestori per il nome dell'evento specificato.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Parametri

eventName

string

handler

IEventHandler<T>

Ereditato da Embed.off

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

Aggiunge un gestore eventi per un evento specifico.

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

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

Parametri

eventName

string

handler

IEventHandler<T>

Ereditato da Embed.on

reload()

Ricarica l'incorporamento usando la configurazione esistente. Ad esempio, per i report questo cancella efficacemente tutti i filtri e rende attiva la prima pagina che simula la reimpostazione di un report sullo stato caricato.

report.reload();

function reload(): Promise<void>

Restituisce

Promise<void>

Ereditato da Embed.reload

removeComponentTabIndex(number)

Rimuove l'attributo tabindex dell'elemento

function removeComponentTabIndex(_tabIndex?: number)

Parametri

_tabIndex

number

Ereditato da Embed.removeComponentTabIndex

save()

Salva report.

function save(): Promise<void>

Restituisce

Promise<void>

Ereditato da Embed.save

saveAs(ISaveAsParameters)

SaveAs Report.

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

Parametri

saveAsParameters
ISaveAsParameters

Restituisce

Promise<void>

Ereditato da Embed.saveAs

setAccessToken(string)

Impostare accessToken.

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

Parametri

accessToken

string

Restituisce

Promise<void>

Ereditato da Embed.setAccessToken

setComponentTabIndex(number)

Imposta l'attributo tabindex dell'elemento

function setComponentTabIndex(tabIndex?: number)

Parametri

tabIndex

number

Ereditato da Embed.setComponentTabIndex

setComponentTitle(string)

Impostare il titolo del componente per l'accessibilità. In caso di iframe, questo metodo modificherà il titolo dell'iframe.

function setComponentTitle(title: string)

Parametri

title

string

ereditato da Embed.setComponentTitle