Struttura del progetto visivo di Power BI

Il modo migliore per iniziare a creare un nuovo oggetto visivo di Power BI consiste nell'usare lo strumento pbiviz degli oggetti visivi di Power BI.

Per creare un nuovo oggetto visivo, passare alla directory in cui si vuole che l'oggetto visivo di Power BI risieda ed eseguire il comando:

pbiviz new <visual project name>

L'esecuzione di questo comando crea una cartella visiva di Power BI contenente i file seguenti:

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

Descrizione cartella e file

Questa sezione fornisce informazioni per ogni cartella e file nella directory creata dallo strumento pbiviz degli oggetti visivi di Power BI.

.vscode

Questa cartella contiene le impostazioni del progetto VS Code.

Per configurare l'area di lavoro, modificare il .vscode/settings.json file.

Per altre informazioni, vedere Impostazioni utente e area di lavoro.

assets

Questa cartella contiene il icon.png file .

Lo strumento oggetti visivi di Power BI usa questo file come nuova icona dell'oggetto visivo di Power BI nel riquadro di visualizzazione di Power BI. Questa icona deve essere un file PNG con dimensioni di 20 pixel per 20 pixel.

src

Questa cartella contiene il codice sorgente dell'oggetto visivo.

In questa cartella lo strumento oggetti visivi di Power BI crea i file seguenti:

  • visual.ts - Codice sorgente principale dell'oggetto visivo. Informazioni sull'API visiva.
  • settings.ts - Codice delle impostazioni dell'oggetto visivo. Le classi nel file forniscono un'interfaccia per la definizione delle proprietà dell'oggetto visivo.

style

Questa cartella contiene il visual.less file che contiene gli stili dell'oggetto visivo.

capabilities.json

Questo file contiene le proprietà e le impostazioni principali (o funzionalità) per l'oggetto visivo. Consente all'oggetto visivo di dichiarare funzionalità, oggetti, proprietà e mapping di visualizzazione dati supportati.

package-lock.json

Questo file viene generato automaticamente per qualsiasi operazione in cui npm modifica l'albero node_modules o il package.json file.

Per altre informazioni su questo file, vedere la documentazione ufficiale di npm-package-lock.json .

package.json

Questo file descrive il pacchetto del progetto. Contiene informazioni sul progetto, ad esempio autori, descrizione e dipendenze del progetto.

Per altre informazioni su questo file, vedere la documentazione ufficiale di npm-package.json .

pbiviz.json

Questo file contiene i metadati visivi.

Per visualizzare un file di esempio pbiviz.json con commenti che descrivono le voci di metadati, vedere la sezione voci di metadati.

tsconfig.json

Un file di configurazione per TypeScript.

Questo file deve contenere il percorso del file *.ts in cui si trova la classe principale dell'oggetto visivo, come specificato nella visualClassName proprietà nel pbiviz.json file.

tslint.json

Questo file contiene la configurazione TSLint.

Voci di metadati

I commenti nel codice seguente didascalia dal pbiviz.json file descrivono le voci di metadati. Alcuni metadati, ad esempio il nome e il messaggio di posta elettronica dell'autore, sono necessari prima di poter creare il pacchetto dell'oggetto visivo.

Nota

{
  "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": []
}