Projektstruktur för visuella Power BI-objekt

  • Artikel

Det bästa sättet att börja skapa ett nytt visuellt Power BI-objekt är att använda verktyget Pbiviz för visuella Power BI-objekt.

Om du vill skapa ett nytt visuellt objekt går du till den katalog som du vill att det visuella Power BI-objektet ska finnas i och kör kommandot:

pbiviz new <visual project name>

När du kör det här kommandot skapas en mapp för visuella Power BI-objekt som innehåller följande filer:

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

Mapp- och filbeskrivning

Det här avsnittet innehåller information om varje mapp och fil i katalogen som pbiviz-verktyget för visuella Power BI-objekt skapar.

.vscode

Den här mappen innehåller VS Code-projektinställningarna.

Om du vill konfigurera arbetsytan redigerar du .vscode/settings.json filen.

Mer information finns i Inställningar för användare och arbetsytor.

tillgångar

Den här mappen innehåller icon.png filen.

Verktyget visuella Power BI-objekt använder den här filen som den nya visuella Power BI-ikonen i power BI-visualiseringsfönstret. Den här ikonen måste vara en PNG-fil med måtten 20 bildpunkter och 20 bildpunkter.

src

Den här mappen innehåller det visuella objektets källkod.

I den här mappen skapar verktyget visuella Power BI-objekt följande filer:

  • visual.ts - Det visuella objektets huvudsakliga källkod. Läs om det visuella API:et.
  • settings.ts – Koden för det visuella objektets inställningar. Klasserna i filen ger ett gränssnitt för att definiera egenskaperna för ditt visuella objekt.

style

Den här mappen innehåller visual.less filen som innehåller det visuella objektets formatmallar.

capabilities.json

Den här filen innehåller de viktigaste egenskaperna och inställningarna (eller funktionerna) för det visuella objektet. Det gör att det visuella objektet kan deklarera funktioner, objekt, egenskaper och datavymappning som stöds.

package-lock.json

Den här filen genereras automatiskt för alla åtgärder där npm ändrar antingen node_modules trädet eller package.json filen.

Mer information om den här filen finns i den officiella dokumentationen npm-package-lock.json .

package.json

Den här filen beskriver projektpaketet. Den innehåller information om projektet, till exempel författare, beskrivning och projektberoenden.

Mer information om den här filen finns i den officiella npm-package.json-dokumentationen .

pbiviz.json

Den här filen innehåller de visuella metadata.

Om du vill visa en exempelfil pbiviz.json med kommentarer som beskriver metadataposterna läser du avsnittet metadataposter .

tsconfig.json

En konfigurationsfil för TypeScript.

Den här filen måste innehålla sökvägen till filen *.ts där huvudklassen för det visuella objektet finns, enligt vad som anges i visualClassName egenskapen i pbiviz.json filen.

tslint.json

Den här filen innehåller TSLint-konfigurationen.

Metadataposter

Kommentarerna i följande kod bildtext från pbiviz.json filen beskriver metadataposterna. Vissa metadata, till exempel författarens namn och e-post, krävs innan du kan paketera det visuella objektet.

Kommentar

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

Relaterat innehåll