Incorporer un tableau de bord

Cet article décrit les étapes d’incorporation d’un tableau de bord dans votre application. En savoir plus sur les tableaux de bord dans Présentation des tableaux de bord pour les concepteurs Power BI.

Pourboire

Essayez d’incorporer un tableau de bord ou d’expérimenter nos API clientes dans la section Explorer nos API de la jeu Power BI Embedded Analytics.

Guide pratique pour incorporer un tableau de bord

Lorsque vous incorporez du contenu Power BI dans une application, vous utilisez un objet de configuration pour définir le contenu que vous incorporez et pour spécifier les paramètres du contenu. Ensuite, vous passez cet objet à l’API.

Lorsque vous incorporez un tableau de bord, utilisez un objet de configuration de type IDashboardLoadConfiguration:

interface IDashboardLoadConfiguration {
    accessToken: string;
    embedUrl?: string;
    id: string;
    pageView?: models.PageView 
    tokenType?: models.TokenType;
    type: string;
}

Cette interface contient les propriétés suivantes :

  • accessToken : jeton qui vous donne accès aux données Power BI que vous incorporez. Consultez Comprendre les différentes solutions d’incorporation pour en savoir plus sur les jetons d’accès.

  • embedUrl : URL du tableau de bord que vous incorporez. Cette URL devient la source de l’élément HTML iframe qui contient le tableau de bord incorporé. Plus précisément, l’API affecte l’URL à l’attribut src du iframe. Vous pouvez utiliser une api Dashboards pour obtenir cette URL. Deux exemples sont les suivants :

  • id : ID du tableau de bord que vous incorporez. Utilisez une API Dashboards pour obtenir cet ID. Par exemple:

  • pageView : format utilisé par l’API pour le tableau de bord incorporé. Les possibilités sont les suivantes :

    • fitToWidth : la largeur du tableau de bord incorporé correspond à la largeur de l’élément div qui contient le tableau de bord.
    • oneColumn : le tableau de bord incorporé apparaît dans une colonne.
    • actualSize : l’API affiche le tableau de bord incorporé à pleine taille.
  • tokenType : type de jeton qui vous donne accès aux données Power BI que vous incorporez.

    • Utilisez models.TokenType.Aad pour incorporer pour votre organisation ('utilisateur possède des données).
    • Utilisez models.TokenType.Embed pour incorporer vos clients (application possède des données).

    Pour plus d’informations, consultez Comprendre les différentes solutions d’incorporation.

  • type : type de contenu que vous incorporez. Utilisez 'dashboard' pour un tableau de bord.

Exemple

L’exemple suivant montre comment incorporer un tableau de bord unique :

// Set up the configuration object that determines what to embed and how to embed it.
let embedConfiguration = {
    accessToken: anAccessToken,
    embedUrl: anEmbedUrl,
    id: aDashboardId,
    pageView: 'fitToWidth',
    tokenType: aTokenType,
    type: 'dashboard'
};
 
// Get a reference to the HTML element that contains the embedded dashboard.
let dashboardContainer = $('#dashboardContainer')[0];
 
// Embed the dashboard.
let dashboard = powerbi.embed(dashboardContainer, embedConfiguration);

Considérations et limitations

  • L’incorporation de tableaux de bord sur des références SKU EM n’est pas prise en charge

  • Lorsque vous incorporez du contenu, votre application affiche le contenu dans un élément div. Si vous utilisez une valeur pageView de actualSize lorsque vous incorporez un tableau de bord :

    • Si le tableau de bord est plus large que l’élément div, l’API utilise la largeur de l’élément div comme largeur du tableau de bord incorporé.
    • Si le tableau de bord est plus étroit que l’élément div, l’API remplit l’espace inutilisé avec l’arrière-plan incorporé. Par défaut, cet arrière-plan est blanc, mais vous pouvez le configurer pour qu’il soit transparent. Dans ce cas, le style de l’élément div est visible dans l’espace inutilisé.