Partager via

Dashboard class

Colis:
powerbi-client

Composant d’incorporation d’un tableau de bord Power BI

S' étend

Embed

Méthode

getId()

Obtenez l’ID de tableau de bord à partir du premier emplacement disponible : options, attribut, URL incorporée.

Méthodes héritées

exitFullscreen()

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

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

Obtenez l’ID de corrélation 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 de 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 de la 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)

Définit l’attribut tabindex de l’élément
setComponentTitle(string)

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

Détails de la méthode

getId()

Obtenez l’ID de tableau de bord à partir du premier emplacement disponible : options, attribut, URL incorporée.

function getId(): string

Retourne

string

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

exitFullscreen()

Demande au navigateur de quitter le mode plein écran.

function exitFullscreen()

héritée de Embed.exitFullscreen

fullscreen()

Demande au navigateur d’afficher l’iframe du composant en mode plein écran.

function fullscreen()

héritée de Embed.fullscreen

getCorrelationId()

Obtenez l’ID de corrélation pour la session incorporée actuelle.

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

function getCorrelationId(): Promise<string>

Retourne

Promise<string>

héritée 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 de 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ée 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ée de Embed.on

reload()

Recharge l’incorporation à l’aide de la 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>

Retourne

Promise<void>

héritée de Embed.reload

removeComponentTabIndex(number)

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

function removeComponentTabIndex(_tabIndex?: number)

Paramètres

_tabIndex

number

héritée de Embed.removeComponentTabIndex

save()

Enregistre le rapport.

function save(): Promise<void>

Retourne

Promise<void>

héritée de Embed.save

saveAs(ISaveAsParameters)

Rapport SaveAs.

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

Paramètres

saveAsParameters
ISaveAsParameters

Retourne

Promise<void>

héritée de Embed.saveAs

setAccessToken(string)

Définissez accessToken.

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

Paramètres

accessToken

string

Retourne

Promise<void>

héritée de Embed.setAccessToken

setComponentTabIndex(number)

Définit l’attribut tabindex de l’élément

function setComponentTabIndex(tabIndex?: number)

Paramètres

tabIndex

number

héritée de Embed.setComponentTabIndex

setComponentTitle(string)

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

function setComponentTitle(title: string)

Paramètres

title

string

héritée de Embed.setComponentTitle