Prosjektstruktur for visualobjekt i Power BI

  • Artikkel
  • 3 minutter å lese

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>

Når du kjører denne kommandoen, opprettes en mappe for Power BI-visualobjektet 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 innholder informasjon om hver mappe og fil i katalogen som pbiviz-verktøyet for Power BI-visualobjekter oppretter.

.vscode

Denne mappen inneholder prosjektinnstillingene for VS Code.

For å konfigurere arbeidsområdet, redigerer du .vscode/settings.json-filen.

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

ressurser

Denne mappen inneholder icon.png-filen.

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

src

Denne mappen inneholder kildekoden til visualobjektet.

I denne mappen oppretter verktøyet for Power BI-visualobjekter følgende filer:

stil

Denne mappen inneholder visual.less-filen, som inneholder stilene til visualobjekter.

capabilities.json

Denne filen inneholder hovedegenskaper og innstillinger (eller egenskaper) for visualobjektet. Den tillater visualobjektet å erklære støttede funksjoner, objekter, egenskaper og tilordning av datavisning.

package-lock.json

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

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

package.json

Denne filen beskriver prosjektpakken. Vanligvis inneholder den informasjon om prosjektet slik som forfatterne, beskrivelse og prosjektavhengigheter.

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

pbiviz.json

Denne filen inneholder metadataene til visualobjektet.

For å se en pbiviz.json-eksempelfil med kommentarer som beskriver oppføringene i metadataene, kan du se metadataoppføringer-delen.

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.

Obs!

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

Neste trinn