Struktura projektu vizuálu Power BI

  • Článek

Nejlepším způsobem, jak začít vytvářet nový vizuál Power BI, je použít nástroj pbiviz vizuálů Power BI.

Pokud chcete vytvořit nový vizuál, přejděte do adresáře, ve kterém se má vizuál Power BI nacházet, a spusťte příkaz:

pbiviz new <visual project name>

Spuštěním tohoto příkazu se vytvoří složka vizuálu Power BI, která obsahuje následující soubory:

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

Popis složky a souboru

Tato část obsahuje informace o každé složce a souboru v adresáři, který nástroj pbiviz vizuálů Power BI vytvoří.

.vscode

Tato složka obsahuje nastavení projektu VS Code.

Pokud chcete nakonfigurovat pracovní prostor, upravte .vscode/settings.json soubor.

Další informace najdete v tématu Nastavení uživatele a pracovního prostoru.

prostředky

Tato složka obsahuje icon.png soubor.

Nástroj vizuálů Power BI používá tento soubor jako novou ikonu vizuálu Power BI v podokně vizualizace Power BI. Tato ikona musí být soubor PNG s rozměry 20 pixelů o 20 pixelů.

src

Tato složka obsahuje zdrojový kód vizuálu.

V této složce nástroj vizuálů Power BI vytvoří následující soubory:

  • visual.ts – Hlavní zdrojový kód vizuálu. Přečtěte si informace o rozhraní API vizuálu.
  • settings.ts – Kód nastavení vizuálu. Třídy v souboru poskytují rozhraní pro definování vlastností vizuálu.

– styl

Tato složka obsahuje visual.less soubor, který obsahuje styly vizuálu.

capabilities.json

Tento soubor obsahuje hlavní vlastnosti a nastavení (nebo možnosti) vizuálu. Umožňuje vizuálu deklarovat podporované funkce, objekty, vlastnosti a mapování zobrazení dat.

package-lock.json

Tento soubor se automaticky vygeneruje pro všechny operace, ve kterých npm upraví node_modules strom nebo package.json soubor.

Další informace o tomto souboru najdete v oficiální dokumentaci k souboru npm-package-lock.json .

package.json

Tento soubor popisuje balíček projektu. Obsahuje informace o projektu, jako jsou autoři, popis a závislosti projektu.

Další informace o tomto souboru najdete v oficiální dokumentaci k souboru npm-package.json .

pbiviz.json

Tento soubor obsahuje metadata vizuálu.

Pokud chcete zobrazit ukázkový pbiviz.json soubor s komentáři popisujícími položky metadat, přečtěte si část položky metadat.

tsconfig.json

Konfigurační soubor pro TypeScript.

Tento soubor musí obsahovat cestu k souboru *.ts , kde je umístěna hlavní třída vizuálu, jak je uvedeno ve visualClassName vlastnosti v pbiviz.json souboru.

tslint.json

Tento soubor obsahuje konfiguraci TSLint.

Položky metadat

Komentáře v následujícím kódu popis ze pbiviz.json souboru popisují položky metadat. Před zabalením vizuálu se vyžadují určitá metadata, jako je jméno autora a e-mail.

Poznámka:

  • Z verze 3.x.x nástrojeexternalJS pbiviz se nepodporuje.
  • Čísla verzí by měla obsahovat čtyři číslice v následujícím formátu x.x.x.x.
  • Pokud chcete podporu lokalizace, přidejte do vizuálu národní prostředí Power BI.
{
  "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": []
}

Související obsah