Bagikan melalui


Struktur proyek visual Power BI

Cara terbaik untuk mulai membuat visual Power BI baru adalah dengan menggunakan alat pbiviz visual Power BI.

Untuk membuat visual baru, buka direktori tempat Anda ingin visual Power BI berada, dan jalankan perintah:

pbiviz new <visual project name>

Menjalankan perintah ini akan membuat folder visual Power BI yang berisi file berikut:

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

Deskripsi folder dan file

Bagian ini menyediakan informasi untuk setiap folder dan file di direktori yang dibuat oleh alat pbiviz visual Power BI.

.vscode

Folder ini berisi pengaturan proyek Visual Studio Code.

Untuk mengonfigurasi ruang kerja, edit file .vscode/settings.json.

Untuk informasi selengkapnya, lihat Pengaturan pengguna dan ruang kerja.

assets

Folder ini berisi file icon.png.

Alat visual Power BI menggunakan file ini sebagai ikon visual Power BI baru di panel visualisasi Power BI. Ikon ini harus berupa file PNG dengan dimensi 20 piksel sebesar 20 piksel.

src

Folder ini berisi kode sumber visual.

Dalam folder ini, alat visual Power BI membuat file berikut:

  • visual.ts - Kode sumber utama visual. Baca tentang Visual API.
  • settings.ts - Kode pengaturan visual. Kelas dalam file menyediakan antarmuka untuk menentukan properti visual Anda.

gaya

Folder ini berisi file visual.less, yang menyimpan gaya visual.

capabilities.json

File ini berisi properti dan pengaturan utama (atau kapabilitas) untuk visual. Ini memungkinkan visual mendeklarasikan fitur, objek, properti, dan pemetaan tampilan data yang didukung.

paket-lock.json

File ini secara otomatis dibuat untuk setiap operasi tempat npm memodifikasi pohon node_modules, atau file package.json.

Untuk informasi selengkapnya tentang file ini, lihat dokumentasi npm-package-lock.json resmi.

package.json

File ini menjelaskan paket proyek. Ini berisi informasi tentang proyek seperti penulis, deskripsi, dan dependensi proyek.

Untuk informasi selengkapnya tentang file ini, lihat dokumentasi npm-package.json resmi.

pbiviz.json

File ini berisi metadata visual.

Untuk melihat contoh file pbiviz.json dengan komentar yang menjelaskan entri metadata, lihat bagian entri metadata.

tsconfig.json

File konfigurasi untuk TypeScript.

File ini harus berisi jalur ke file *.ts tempat kelas utama visual berada, seperti ditentukan dalam properti visualClassName dalam file pbiviz.json.

tslint.json

File ini berisi konfigurasi TSLint.

Entri metadata

Komentar dalam keterangan kode berikut dari pbiviz.json file menjelaskan entri metadata. Metadata tertentu, seperti nama dan email penulis, diperlukan sebelum Anda dapat mengemas visual.

Catatan

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