Prosjektstruktur for visualobjekter i Power BI

  • Artikkel

Den beste måten å begynne å opprette et nytt Power BI-visualobjekt på, er å bruke pbiviz-verktøyet for Power BI-visualobjekter.

Hvis du vil opprette et nytt visualobjekt, navigerer du til katalogen du vil at Power BI-visualobjektet skal ligge i, og kjører kommandoen:

pbiviz new <visual project name>

Hvis du kjører denne kommandoen, opprettes en Power BI-visuell mappe som inneholder 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

Denne delen inneholder informasjon for hver mappe og fil i katalogen som power bi-visualobjekter pbiviz-verktøyet oppretter.

.vscode

Denne mappen inneholder prosjektinnstillingene for VS Code.

Hvis du vil konfigurere arbeidsområdet, redigerer .vscode/settings.json du filen.

Hvis du vil ha mer informasjon, kan du se Bruker- og arbeidsområdeinnstillinger.

assets

Denne mappen inneholder icon.png filen.

Visualobjektverktøyet for Power BI bruker denne filen som det nye visualobjektikonet for Power BI i visualiseringsruten i Power BI. Dette ikonet må være en PNG-fil med dimensjoner på 20 x 20 piksler.

src

Denne mappen inneholder kildekoden for visualobjektet.

I denne mappen oppretter visualobjektverktøyet for Power BI følgende filer:

  • visual.ts - Visualobjektets hovedkildekode. Les om visualobjekt-API-en.
  • settings.ts - Koden for innstillingene for visualobjektet. Klassene i filen gir et grensesnitt for å definere egenskapene for visualobjektet.

style

Denne mappen inneholder visual.less filen, som inneholder stilene til visualobjektet.

capabilities.json

Denne filen inneholder de viktigste egenskapene og innstillingene (eller funksjonene) for visualobjektet. Det gjør det mulig for visualobjektet å deklarere støttede funksjoner, objekter, egenskaper og datavisningstilordning.

package-lock.json

Denne filen genereres automatisk for alle operasjoner der npm endrer enten node_modules treet eller package.json filen.

Hvis du vil ha mer informasjon om denne filen, kan du se den offisielle npm-package-lock.json-dokumentasjonen .

package.json

Denne filen beskriver prosjektpakken. Den inneholder informasjon om prosjektet, for eksempel forfattere, beskrivelse og prosjektavhengigheter.

Hvis du vil ha mer informasjon om denne filen, kan du se den offisielle npm-package.json-dokumentasjonen .

pbiviz.json

Denne filen inneholder metadataene for visualobjekter.

Hvis du vil vise en eksempelfil pbiviz.json med kommentarer som beskriver metadataoppføringene, kan du se inndelingen metadataoppføringer .

tsconfig.json

En konfigurasjonsfil for TypeScript.

Denne filen må inneholde banen til *.ts-filen der hovedklassen for visualobjektet er plassert, som angitt i visualClassName egenskapen i pbiviz.json filen.

tslint.json

Denne filen inneholder TSLint-konfigurasjonen.

Metadataoppføringer

Kommentarene i følgende kodetekst fra pbiviz.json filen beskriver metadataoppføringene. Enkelte metadata, for eksempel forfatterens navn og e-post, kreves før du kan pakke visualobjektet.

Merk

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

Relatert innhold