Structure de projets de visuels Power BI

  • Article

La meilleure façon de commencer à créer un visuel Power BI consiste à utiliser l’outil Power BI pbiviz.

Pour créer un visuel, accédez au répertoire dans lequel vous souhaitez placer le visuel Power BI, puis exécutez la commande :

pbiviz new <visual project name>

L’exécution de cette commande crée un dossier de visuels Power BI contenant les fichiers suivants :

project
├───.vscode
│   ├───launch.json
│   └───settings.json
├───assets
│   └───icon.png
├───node_modules
├───src
│   ├───settings.ts
│   └───visual.ts
├───style
│   └───visual.less
├───capabilities.json
├───package-lock.json
├───package.json
├───pbiviz.json
├───tsconfig.json
└───tslint.json

Description des dossiers et fichiers

Cette section fournit des informations pour chaque dossier et fichier du répertoire créés par l’outil des visuelspbiciz Power BI.

.vscode

Ce dossier contient les paramètres du projet VS Code.

Pour configurer votre espace de travail, modifiez le fichier .vscode/settings.json.

Pour plus d’informations, consultez Paramètres de l’utilisateur et de l’espace de travail.

ressources

Ce dossier contient le fichier icon.png.

L’outil Power BI utilise ce fichier comme icône de nouveau visuel Power BI dans le volet de visualisation Power BI. Cette icône être un fichier PNG avec les dimensions 20 pixels par 20 pixels.

src

Ce dossier contient le code source du visuel.

Dans ce dossier, l’outil Power BI crée les fichiers suivants :

  • visual.ts : code source principal du visuel. En savoir plus sur l’API Visual.
  • settings.ts : code des paramètres du visuel. Les classes du fichier fournissent une interface permettant de définir les propriétés de votre visuel.

style

Ce dossier contient le fichier visual.less, qui définit les styles du visuel.

capabilities.json

Ce fichier contient les propriétés et paramètres principaux (ou fonctionnalités) du visuel. Il permet au visuel de déclarer les fonctionnalités, les objets, les propriétés et le mappage de vues de données pris en charge.

package-lock.json

Ce ficher est généré automatiquement pour toutes les opérations où npm modifie l’arborescence node_modules ou le fichier package.json.

Pour plus d’informations sur ce fichier, consultez la documentation officielle npm-package-lock.json.

package.json

Ce fichier décrit le package de projet. Il contient des informations sur le projet, ses auteurs, sa description et ses dépendances.

Pour plus d’informations sur ce fichier, consultez la documentation officielle npm-package.json.

pbiviz.json

Ce fichier contient les métadonnées du visuel.

Pour afficher un exemple de fichier pbiviz.json avec des commentaires décrivant les entrées de métadonnées, consultez la section sur les entrées de métadonnées.

tsconfig.json

Un fichier de configuration pour TypeScript.

Ce fichier doit contenir le chemin du fichier *.ts dans lequel se trouve la classe principale du visuel, comme spécifié dans la propriété visualClassName du fichier pbiviz.json.

tslint.json

Ce fichier contient la configuration TSLint.

Entrées de métadonnées

Les commentaires figurant dans la légende de code suivante du fichier pbiviz.json décrivent les entrées de métadonnées. Certaines métadonnées, comme le nom et l’e-mail de l’auteur, sont nécessaires pour pouvoir packager le visuel.

Notes

{
  "visual": {
     // The visual's internal name.
    "name": "<visual project name>",

    // The visual's display name.
    "displayName": "<visual project name>",

    // The visual's unique ID.
    "guid": "<visual project name>23D8B823CF134D3AA7CC0A5D63B20B7F",

    // The name of the visual's main class. Power BI creates the instance of this class to start using the visual in a Power BI report.
    "visualClassName": "Visual",

    // The visual's version number.
    "version": "1.0.0.0",
    
    // The visual's description (optional)
    "description": "",

    // A URL linking to the visual's support page (optional).
    "supportUrl": "",

    // A link to the source code available from GitHub (optional).
    "gitHubUrl": ""
  },
  // The version of the Power BI API the visual is using.
  "apiVersion": "2.6.0",

  // The name of the visual's author and email.
  "author": { "name": "", "email": "" },

  // 'icon' holds the path to the icon file in the assets folder; the visual's display icon.
  "assets": { "icon": "assets/icon.png" },

  // Contains the paths for JS libraries used in the visual.
  // Note: externalJS' isn't used in the Power BI visuals tool version 3.x.x or higher.
  "externalJS": null,

  // The path to the 'visual.less' style file.
  "style": "style/visual.less",

  // The path to the `capabilities.json` file.
  "capabilities": "capabilities.json",

  // The path to the `dependencies.json` file which contains information about R packages used in R based visuals.
  "dependencies": null,

  // An array of paths to files with localizations.
  "stringResources": []
}

Contenu connexe