Projektstruktur for visualiseringer i Power BI

  • Artikel

Den bedste måde at begynde at oprette en ny Power BI-visualisering på er ved at bruge værktøjet Power BI-visualiseringer pbiviz .

Hvis du vil oprette en ny visualisering, skal du navigere til den mappe, som Power BI-visualiseringen skal være placeret i, og køre kommandoen:

pbiviz new <visual project name>

Hvis du kører denne kommando, oprettes der en Power BI-visualiseringsmappe, der indeholder følgende 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

Mappe- og filbeskrivelse

Dette afsnit indeholder oplysninger om hver mappe og fil i den mappe, som værktøjet Power BI-visualiseringer pbiviz opretter.

.vscode

Denne mappe indeholder projektindstillingerne for VS Code.

Hvis du vil konfigurere dit arbejdsområde, skal du .vscode/settings.json redigere filen.

Du kan få flere oplysninger under Indstillinger for bruger og arbejdsområde.

assets

Denne mappe indeholder icon.png filen.

Værktøjet Power BI-visualiseringer bruger denne fil som det nye ikon for Power BI-visualiseringer i ruden Power BI-visualisering. Dette ikon skal være en PNG-fil med dimensioner 20 pixel gange 20 pixel.

src

Denne mappe indeholder visualiseringens kildekode.

I denne mappe opretter værktøjet Power BI-visualiseringer følgende filer:

  • visual.ts – Visualiseringens primære kildekode. Læs om Visual-API'en.
  • settings.ts – Koden for visualiseringens indstillinger. Klasserne i filen indeholder en grænseflade til definition af egenskaberne for visualiseringen.

style

Denne mappe indeholder filen visual.less , som indeholder typografierne for visualiseringen.

capabilities.json

Denne fil indeholder de primære egenskaber og indstillinger (eller egenskaber) for visualiseringen. Det gør det muligt for visualiseringen at deklarere understøttede funktioner, objekter, egenskaber og tilknytning af datavisninger.

package-lock.json

Denne fil genereres automatisk for alle handlinger, hvor npm ændrer enten node_modules træet eller package.json filen.

Du kan få flere oplysninger om denne fil i den officielle dokumentation til npm-package-lock.json .

package.json

Denne fil beskriver projektpakken. Den indeholder oplysninger om projektet, f.eks. forfattere, beskrivelse og projektafhængigheder.

Du kan få flere oplysninger om denne fil i den officielle dokumentation til npm-package.json .

pbiviz.json

Denne fil indeholder visualiseringens metadata.

Hvis du vil have vist en eksempelfil pbiviz.json med kommentarer, der beskriver metadataposterne, skal du se afsnittet metadataposter .

tsconfig.json

En konfigurationsfil til TypeScript.

Denne fil skal indeholde stien til *.ts-filen , hvor visualiseringens hovedklasse er placeret, som angivet i visualClassName egenskaben i pbiviz.json filen.

tslint.json

Denne fil indeholder TSLint-konfigurationen.

Metadataposter

Kommentarerne i følgende kodetekst fra pbiviz.json filen beskriver metadataposterne. Visse metadata, f.eks. forfatterens navn og mail, er påkrævet, før du kan pakke visualiseringen.

Bemærk

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

Relateret indhold