Struktur for visual-projekter i Power BI

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

Hvis du vil oprette et nyt visuelt element, skal du gå til den mappe, som Power BI-visualiseringen skal placeres i, og køre kommandoen:

pbiviz new <visual project name>

Når du kører denne kommando, oprettes 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

Beskrivelse af mappe og fil

Dette afsnit indeholder oplysninger om hver mappe og fil i mappen, som værktøjet pbiviz til visuals i Power BI opretter.

.vscode

Denne mappe indeholder VS-kodeprojektindstillingerne.

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

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

assets

Denne mappe indeholder filen icon.png.

Power BI-visualiseringsværktøjet bruger denne fil som det nye Power BI-visualiseringsikon i ruden Visualiseringer i Power BI. Dette ikon skal være en PNG-fil, 20 pixel gange 20 pixel.

src

Denne mappe indeholder kildekoden til visualiseringen.

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

• visual.ts – visualiseringens hovedkildekode.
• settings.ts – visualiseringens indstillingskode. Klasserne i filen indeholder en grænseflade til definition af egenskaber for visualiseringen.

typografi

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

capabilities.json

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

package-lock.json

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

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

package.json

Denne fil beskriver projektpakken. Den indeholder normalt oplysninger om projektet, f.eks. forfatterne, beskrivelsen af og afhængighederne i projektet.

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

pbiviz.json

Denne fil indeholder metadata om visualiseringen.

Hvis du vil have vist et eksempel på filen pbiviz.json med kommentarer, der beskriver metadataposterne, skal du se afsnittet metadataposter.

tsconfig.json

Er en konfigurationsfil til TypeScript.

Denne fil skal indeholde en sti til *.ts-filen, hvor visualiseringens primære klasse er placeret som angivet i egenskaben visualClassName i filen pbiviz.json.

tslint.json

Denne fil indeholder TSLint-konfigurationen.

Metadataposter

Kommentarerne i den følgende kodetekst fra pbiviz.json-filen beskriver metadataposterne. Der kræves visse metadata (f.eks. forfatterens navn og mail), før du kan pakke visualiseringen.

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

Næste trin