Estrutura do projeto visual do Power BI

A melhor maneira de começar a criar um novo visual do Power BI é usar a ferramenta pbiviz de visuais do Power BI.

Para criar um novo visual, navegue até o diretório no qual você deseja que o visual do Power BI resida e execute o comando:

pbiviz new <visual project name>

A execução deste comando cria uma pasta visual do Power BI que contém os seguintes ficheiros:

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

Descrição da pasta e do ficheiro

Esta seção fornece informações para cada pasta e arquivo no diretório que a ferramenta pbiviz de visuais do Power BI cria.

.vscode

Esta pasta contém as configurações do projeto VS Code.

Para configurar seu espaço de trabalho, edite o .vscode/settings.json arquivo.

Para obter mais informações, consulte Configurações de usuário e espaço de trabalho.

recursos

Esta pasta contém o icon.png arquivo.

A ferramenta de visuais do Power BI usa esse arquivo como o novo ícone visual do Power BI no painel de visualização do Power BI. Este ícone deve ser um arquivo PNG com dimensões de 20 pixels por 20 pixels.

src

Esta pasta contém o código-fonte do visual.

Nesta pasta, a ferramenta de visuais do Power BI cria os seguintes ficheiros:

• visual.ts - O código-fonte principal do visual. Leia sobre a API Visual.
• settings.ts - O código das configurações do visual. As classes no arquivo fornecem uma interface para definir as propriedades do visual.

style

Esta pasta contém o visual.less arquivo, que contém os estilos do visual.

capabilities.json

Este arquivo contém as principais propriedades e configurações (ou recursos) para o visual. Ele permite que o visual declare recursos, objetos, propriedades e mapeamento de exibição de dados suportados.

package-lock.json

Esse arquivo é gerado automaticamente para todas as operações em que o npm modifica a node_modules árvore ou o package.json arquivo.

Para obter mais informações sobre esse arquivo, consulte a documentação oficial do npm-package-lock.json .

package.json

Este arquivo descreve o pacote do projeto. Ele contém informações sobre o projeto, como autores, descrição e dependências do projeto.

Para obter mais informações sobre esse arquivo, consulte a documentação oficial do npm-package.json .

pbiviz.json

Este arquivo contém os metadados visuais.

Para exibir um arquivo de exemplo pbiviz.json com comentários descrevendo as entradas de metadados, consulte a seção Entradas de metadados.

tsconfig.json

Um arquivo de configuração para TypeScript.

Esse arquivo deve conter o caminho para o arquivo *.ts onde a classe principal do visual está localizada, conforme especificado na visualClassName propriedade no pbiviz.json arquivo.

tslint.json

Este ficheiro contém a configuração TSLint.

Entradas de metadados

Os comentários na legenda de código a seguir do arquivo descrevem as entradas de pbiviz.json metadados. Certos metadados, como o nome do autor e o e-mail, são necessários antes que você possa empacotar o visual.

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

Conteúdos relacionados

• Integração do sistema de visuais do Power BI
• Desenvolver um visual de cartão circular do Power BI