Projectstructuur van Power BI-visual

De beste manier om een nieuwe Power BI-visual te maken, is door het hulpprogramma Power BI-visuals pbiviz te gebruiken.

Als u een nieuwe visual wilt maken, gaat u naar de map waarin u de Power BI-visual wilt opslaan en voert u de opdracht uit:

pbiviz new <visual project name>

Als u deze opdracht uitvoert, maakt u een Power BI-visualmap die de volgende bestanden bevat:

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

Beschrijving van map en bestand

Deze sectie bevat informatie voor elke map en elk bestand in de map die door het hulpprogramma Power BI-visuals pbiviz wordt gemaakt.

.vscode

Deze map bevat de vs Code-projectinstellingen.

Bewerk het .vscode/settings.json bestand om uw werkruimte te configureren.

Zie Gebruikers- en werkruimte-instellingen voor meer informatie.

assets

Deze map bevat het icon.png bestand.

Het hulpprogramma voor Power BI-visuals gebruikt dit bestand als het nieuwe pictogram van de Power BI-visual in het deelvenster Visualisatie van Power BI. Dit pictogram moet een PNG-bestand zijn met dimensies 20 pixels en 20 pixels.

src

Deze map bevat de broncode van de visual.

In deze map maakt het hulpprogramma Voor Power BI-visuals de volgende bestanden:

  • visual.ts - De belangrijkste broncode van de visual. Meer informatie over de Visual-API.
  • settings.ts - De code van de instellingen van de visual. De klassen in het bestand bieden een interface voor het definiëren van de eigenschappen van uw visual.

stijl

Deze map bevat het visual.less bestand dat de stijlen van de visual bevat.

capabilities.json

Dit bestand bevat de belangrijkste eigenschappen en instellingen (of mogelijkheden) voor de visual. Hiermee kan de visual ondersteunde functies, objecten, eigenschappen en toewijzing van gegevensweergaven declareren.

package-lock.json

Dit bestand wordt automatisch gegenereerd voor bewerkingen waarbij npm de node_modules structuur of het package.json bestand wijzigt.

Zie de officiële npm-package-lock.json-documentatie voor meer informatie over dit bestand.

package.json

In dit bestand wordt het projectpakket beschreven. Het bevat informatie over het project, zoals auteurs, beschrijvingen en projectafhankelijkheden.

Zie de officiële documentatie npm-package.json voor meer informatie over dit bestand.

pbiviz.json

Dit bestand bevat de metagegevens van de visual.

Als u een voorbeeldbestand pbiviz.json met opmerkingen wilt weergeven waarin de metagegevensvermeldingen worden beschreven, raadpleegt u de sectie met metagegevensvermeldingen .

tsconfig.json

Een configuratiebestand voor TypeScript.

Dit bestand moet het pad naar het *.ts-bestand bevatten waarin de hoofdklasse van de visual zich bevindt, zoals opgegeven in de visualClassName eigenschap in het pbiviz.json bestand.

tslint.json

Dit bestand bevat de TSLint-configuratie.

Metagegevensvermeldingen

De opmerkingen in de volgende code onderschrift uit het pbiviz.json bestand beschrijven de metagegevensvermeldingen. Bepaalde metagegevens, zoals de naam en het e-mailadres van de auteur, zijn vereist voordat u de visual kunt verpakken.

Notitie

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