Структура визуального проекта Power BI

  • Статья

Лучший способ приступить к созданию нового визуального элемента Power BI — использовать средство pbiviz визуальных элементов Power BI.

Чтобы создать новый визуальный элемент, перейдите к каталогу, в котором должен находиться визуальный элемент Power BI, и выполните команду:

pbiviz new <visual project name>

При выполнении этой команды создается визуальная папка Power BI, содержащая следующие файлы:

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

Описание папки и файла

В этом разделе содержатся сведения о каждой папке и файле в каталоге, который создает средство pbiviz визуальных элементов Power BI.

.vscode

Эта папка содержит параметры проекта VS Code.

Чтобы настроить рабочую область, измените .vscode/settings.json файл.

Дополнительные сведения см. в разделе "Параметры пользователя и рабочей области".

assets

Эта папка содержит icon.png файл.

Средство визуальных элементов Power BI использует этот файл в качестве нового значка визуального элемента Power BI в области визуализации Power BI. Этот значок должен быть PNG-файлом с измерениями 20 пикселей на 20 пикселей.

src

Эта папка содержит исходный код визуального элемента.

В этой папке средство визуальных элементов Power BI создает следующие файлы:

  • visual.ts — основной исходный код визуального элемента. Ознакомьтесь с визуальным API.
  • settings.ts — код параметров визуального элемента. Классы в файле предоставляют интерфейс для определения свойств визуального элемента.

style

Эта папка содержит visual.less файл, содержащий стили визуального элемента.

capabilities.json

Этот файл содержит основные свойства и параметры (или возможности) для визуального элемента. Он позволяет визуальному элементу объявлять поддерживаемые функции, объекты, свойства и сопоставление представлений данных.

package-lock.json

Этот файл автоматически создается для любых операций, в которых npm изменяет node_modules дерево или package.json файл.

Дополнительные сведения об этом файле см. в официальной документации npm-package-lock.json .

package.json

Этот файл описывает пакет проекта. Он содержит сведения о проекте, например авторах, описаниях и зависимостях проекта.

Дополнительные сведения об этом файле см. в официальной документации npm-package.json .

pbiviz.json

Этот файл содержит визуальные метаданные.

Чтобы просмотреть пример pbiviz.json файла с комментариями, описывающими записи метаданных, см . раздел записей метаданных .

tsconfig.json

Файл конфигурации для TypeScript.

Этот файл должен содержать путь к файлу *.ts , где находится основной класс визуального элемента, как указано в visualClassName свойстве pbiviz.json в файле.

tslint.json

Этот файл содержит конфигурацию TSLint.

Записи метаданных

Примечания в следующем коде подпись из pbiviz.json файла описывают записи метаданных. Для упаковки визуального элемента требуются определенные метаданные, такие как имя автора и электронная почта.

Примечание.

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

Связанный контент