Štruktúra projektu vizuálu služby Power BI

  • Článok

Najlepším spôsobom, ako začať vytvárať nový vizuál služby Power BI, je použiť nástroj pbiviz na vizuály služby Power BI.

Ak chcete vytvoriť nový vizuál, prejdite do adresára, do ktorý chcete vizuál služby Power BI uložiť, a spustite príkaz:

pbiviz new <visual project name>

Spustením tohto príkazu sa vytvorí priečinok vizuálu služby Power BI, ktorý obsahuje nasledujúce súbory:

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 priečinkov a súborov

Táto časť poskytuje informácie o každom priečinku a súbore v adresári, ktorý vytvorí nástroj pbiviz na vizuály služby Power BI.

.vscode

Tento priečinok obsahuje nastavenia projektu VS Code.

Ak chcete nakonfigurovať pracovný priestor, upravte .vscode/settings.json súbor.

Ďalšie informácie nájdete v téme Nastavenia používateľa a pracovného priestoru.

assets

Tento priečinok obsahuje icon.png súbor.

Nástroj na vizuály služby Power BI používa tento súbor ako ikonu nového vizuálu služby Power BI na table Vizualizácia v Power BI. Táto ikona musí byť súbor vo formáte PNG s rozmermi 20 pixlov a 20 pixlov.

src

Tento priečinok obsahuje zdrojový kód vizuálu.

V tomto priečinku nástroj na vizuály služby Power BI vytvorí nasledujúce súbory:

  • visual.ts – hlavný zdrojový kód vizuálu. Prečítajte si informácie o rozhraní API vizuálov.
  • settings.ts – kód nastavení vizuálu. Triedy v súbore poskytujú rozhranie na definovanie vlastností vizuálu.

style

Tento priečinok obsahuje visual.less súbor, ktorý obsahuje štýly vizuálu.

capabilities.json

Tento súbor obsahuje hlavné vlastnosti a nastavenia (alebo možnosti) pre vizuál. Umožňuje vizuálu deklarovať podporované funkcie, objekty, vlastnosti a mapovanie zobrazenia údajov.

package-lock.json

Tento súbor sa automaticky vygeneruje pre všetky operácie, kde npm upravuje buď node_modules strom, alebo package.json súbor.

Ďalšie informácie o tomto súbore nájdete v oficiálnej dokumentácii pre npm-package-lock.json .

package.json

Tento súbor popisuje balík projektu. Obsahuje informácie o projekte, napríklad autorov, popis a závislosti projektu.

Ďalšie informácie o tomto súbore nájdete v oficiálnej dokumentácii pre npm-package.json .

pbiviz.json

Tento súbor obsahuje metaúdaje vizuálu.

Ak chcete zobraziť vzorový pbiviz.json súbor s komentármi popisuucimi položky metaúdajov, pozrite si časť Položky metaúdajov.

tsconfig.json

Konfiguračný súbor pre TypeScript.

Tento súbor musí obsahovať cestu k súboru *.ts , kde sa nachádza hlavná trieda vizuálu zadaná vo visualClassName vlastnosti v súbore pbiviz.json .

tslint.json

Tento súbor obsahuje konfiguráciu TSLint.

Položky metaúdajov

Komentáre v nasledujúcich titulkoch kódu zo pbiviz.json súboru popisujú položky metaúdajov. Pred vytvorením balíka vizuálu sa vyžadujú určité metaúdaje, ako je napríklad meno autora a e-mail.

Poznámka

  • Od verzie 3.x.x nástroja externalJS pbiviz sa už nepodporuje.
  • Čísla verzií by mali obsahovať štyri číslice v nasledujúcom formáte x.x.x.x.
  • Ak chcete získať podporu lokalizácie, pridajte do vizuálu služby Power BI svoje miestne nastavenie.
{
  "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": []
}

Súvisiaci obsah