Partager via

QuickCreate class

  • Référence
Paquet:
powerbi-client

Un composant De création rapide Power BI

Extends

Embed

Constructeurs

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

Méthodes

getId()

Remplacer la fonction abstraite getId QuickCreate n’a besoin d’aucun ID
validate(IEmbedConfigurationBase)

Valider la configuration de création de rapport.

Méthodes héritées

exitFullscreen()

Demande au navigateur de quitter le mode plein écran.
fullscreen()

Demande au navigateur de restituer l’iframe du composant en mode plein écran.
getCorrelationId()

Obtenez le correlationId pour la session incorporée actuelle.

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

Supprime un ou plusieurs gestionnaires d’événements de la liste des gestionnaires. Si une référence à la fonction handle existante est spécifiée, supprimez le gestionnaire spécifique. Si le gestionnaire n’est pas spécifié, supprimez tous les gestionnaires pour le nom d’événement spécifié.

report.off('pageChanged')

or

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

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

Ajoute un gestionnaire d’événements pour un événement spécifique.

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

Recharge l’incorporation à l’aide d’une configuration existante. Par exemple, pour les rapports, cela efface efficacement tous les filtres et active la première page qui simule la réinitialisation d’un rapport à l’état chargé.

report.reload();
removeComponentTabIndex(number)

Supprime l’attribut tabindex de l’élément
save()

Enregistre le rapport.
saveAs(ISaveAsParameters)

Rapport SaveAs.
setAccessToken(string)

Définissez accessToken.
setComponentTabIndex(number)

Attribut tabindex de l’élément Sets
setComponentTitle(string)

Définissez le titre du composant pour l’accessibilité. Dans le cas d’iframes, cette méthode modifie le titre de l’iframe.

Détails du constructeur

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

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

Paramètres

service
Service
element

HTMLElement

config
IQuickCreateConfiguration
phasedRender

boolean

isBootstrap

boolean

Détails de la méthode

getId()

Remplacer la fonction abstraite getId QuickCreate n’a besoin d’aucun ID

function getId(): string

Retours

string

validate(IEmbedConfigurationBase)

Valider la configuration de création de rapport.

function validate(config: IEmbedConfigurationBase): IError[]

Paramètres

config
IEmbedConfigurationBase

Retours

IError[]

Détails de la méthode héritée

exitFullscreen()

Demande au navigateur de quitter le mode plein écran.

function exitFullscreen()

Hérité de Embed.exitFullscreen

fullscreen()

Demande au navigateur de restituer l’iframe du composant en mode plein écran.

function fullscreen()

Hérité de Embed.fullscreen

getCorrelationId()

Obtenez le correlationId pour la session incorporée actuelle.

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

function getCorrelationId(): Promise<string>

Retours

Promise<string>

Hérité de Embed.getCorrelationId

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

Supprime un ou plusieurs gestionnaires d’événements de la liste des gestionnaires. Si une référence à la fonction handle existante est spécifiée, supprimez le gestionnaire spécifique. Si le gestionnaire n’est pas spécifié, supprimez tous les gestionnaires pour le nom d’événement spécifié.

report.off('pageChanged')

or

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

report.off('pageChanged', logHandler);

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

Paramètres

eventName

string

handler

IEventHandler<T>

Hérité de Embed.off

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

Ajoute un gestionnaire d’événements pour un événement spécifique.

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

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

Paramètres

eventName

string

handler

IEventHandler<T>

Hérité de Embed.on

reload()

Recharge l’incorporation à l’aide d’une configuration existante. Par exemple, pour les rapports, cela efface efficacement tous les filtres et active la première page qui simule la réinitialisation d’un rapport à l’état chargé.

report.reload();

function reload(): Promise<void>

Retours

Promise<void>

Hérité de Embed.reload

removeComponentTabIndex(number)

Supprime l’attribut tabindex de l’élément

function removeComponentTabIndex(_tabIndex?: number)

Paramètres

_tabIndex

number

Hérité de Embed.removeComponentTabIndex

save()

Enregistre le rapport.

function save(): Promise<void>

Retours

Promise<void>

Hérité de Embed.save

saveAs(ISaveAsParameters)

Rapport SaveAs.

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

Paramètres

saveAsParameters
ISaveAsParameters

Retours

Promise<void>

Hérité de Embed.saveAs

setAccessToken(string)

Définissez accessToken.

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

Paramètres

accessToken

string

Retours

Promise<void>

Hérité de Embed.setAccessToken

setComponentTabIndex(number)

Attribut tabindex de l’élément Sets

function setComponentTabIndex(tabIndex?: number)

Paramètres

tabIndex

number

Hérité de Embed.setComponentTabIndex

setComponentTitle(string)

Définissez le titre du composant pour l’accessibilité. Dans le cas d’iframes, cette méthode modifie le titre de l’iframe.

function setComponentTitle(title: string)

Paramètres

title

string

Hérité de Embed.setComponentTitle