Struktura projektu wizualizacji usługi Power BI

  • Artykuł

Najlepszym sposobem rozpoczęcia tworzenia nowej wizualizacji usługi Power BI jest użycie narzędzia pbiviz wizualizacji usługi Power BI.

Aby utworzyć nową wizualizację, przejdź do katalogu, w którym ma znajdować się wizualizacja usługi Power BI, a następnie uruchom polecenie:

pbiviz new <visual project name>

Uruchomienie tego polecenia powoduje utworzenie folderu wizualizacji usługi Power BI zawierającego następujące pliki:

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

Opis folderu i pliku

Ta sekcja zawiera informacje dotyczące każdego folderu i pliku w katalogu tworzonym przez narzędzie pbiviz wizualizacji usługi Power BI.

.vscode

Ten folder zawiera ustawienia projektu programu VS Code.

Aby skonfigurować obszar roboczy, edytuj .vscode/settings.json plik.

Aby uzyskać więcej informacji, zobacz Ustawienia użytkownika i obszaru roboczego.

zasoby

Ten folder zawiera icon.png plik.

Narzędzie wizualizacji usługi Power BI używa tego pliku jako nowej ikony wizualizacji usługi Power BI w okienku wizualizacji usługi Power BI. Ta ikona musi być plikiem PNG o wymiarach 20 pikseli o 20 pikseli.

src

Ten folder zawiera kod źródłowy wizualizacji.

W tym folderze narzędzie wizualizacji usługi Power BI tworzy następujące pliki:

  • visual.ts — główny kod źródłowy wizualizacji. Przeczytaj o interfejsie API wizualizacji.
  • settings.ts — kod ustawień wizualizacji. Klasy w pliku zapewniają interfejs do definiowania właściwości wizualizacji.

— styl

Ten folder zawiera visual.less plik, który przechowuje style wizualizacji.

capabilities.json

Ten plik zawiera główne właściwości i ustawienia (lub możliwości) wizualizacji. Umożliwia wizualizacji deklarowanie obsługiwanych funkcji, obiektów, właściwości i mapowania widoku danych.

package-lock.json

Ten plik jest generowany automatycznie dla wszystkich operacji, w których narzędzie npm modyfikuje node_modules drzewo lub package.json plik.

Aby uzyskać więcej informacji na temat tego pliku, zobacz oficjalną dokumentację npm-package-lock.json .

package.json

W tym pliku opisano pakiet projektu. Zawiera on informacje o projekcie, takie jak autorzy, opis i zależności projektu.

Aby uzyskać więcej informacji na temat tego pliku, zobacz oficjalną dokumentację npm-package.json .

pbiviz.json

Ten plik zawiera metadane wizualizacji.

Aby wyświetlić przykładowy pbiviz.json plik z komentarzami opisującym wpisy metadanych, zobacz sekcję Wpisy metadanych.

tsconfig.json

Plik konfiguracji dla języka TypeScript.

Ten plik musi zawierać ścieżkę do pliku *.ts , w którym znajduje się główna klasa wizualizacji, jak określono we visualClassName właściwości w pbiviz.json pliku.

tslint.json

Ten plik zawiera konfigurację TSLint.

Wpisy metadanych

Komentarze w poniższym kodzie podpis z pbiviz.json pliku opisują wpisy metadanych. Aby można było spakować wizualizację, wymagane są pewne metadane, takie jak nazwa i adres e-mail autora.

Uwaga

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

Powiązana zawartość