Estrutura do projeto do visual do Power BI

  • Artigo

A melhor maneira de começar a criar um novo visual no Power BI é usando a ferramenta pbiviz para 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 desse comando cria a pasta do visual do Power BI, que contém os seguintes arquivos:

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 arquivo

Esta seção fornece informações de cada pasta e arquivo do diretório criado pela ferramenta pbiviz dos visuais do Power BI.

.vscode

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

Para configurar seu novo workspace, edite o arquivo .vscode/settings.json.

Para obter mais informações, consulte Configurações do usuário e do workspace.

ativos

Esta pasta contém o arquivo icon.png.

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

src

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

Nessa pasta, a ferramenta de visuais do Power BI cria os seguintes arquivos:

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

estilo

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

capabilities.json

Esse arquivo contém as principais propriedades e configurações (ou funcionalidades) do visual. Ele permite que o visual declare recursos, objetos, propriedades e mapeamentos de exibição de dados com suporte.

package-lock.json

Esse arquivo é gerado automaticamente para qualquer operação em que o npm modifique a árvore node_modules ou o arquivo package.json.

Saiba mais sobre esse arquivo na documentação oficial do npm-package-lock.json.

package.json

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

Saiba mais sobre esse arquivo na documentação oficial do npm-package.json.

pbiviz.json

Este arquivo contém os metadados do visual.

Para exibir o arquivo pbiviz.json de exemplo com comentários que descrevem as entradas de metadados, confira a seção entradas de metadados.

tsconfig.json

Um arquivo de configuração para TypeScript.

O arquivo deve conter o caminho para o arquivo *.ts, em que a classe principal do visual está localizada na propriedade visualClassName do arquivo pbiviz.json.

tslint.json

O arquivo contém a configuração de TSLint.

Entradas de metadados

Os comentários na legenda de código a seguir do arquivo pbiviz.json descrevem as entradas de metadados. Determinados metadados, como o nome e o email do autor, são necessários para que você empacote o visual.

Observação

  • Começando na versão 3.x.x da ferramenta pbiviz, externalJS não é compatível.
  • Os números de versão devem conter quatro dígitos no formato a seguir x.x.x.x.
  • Para receber suporte para localização, adicione a localidade do Power BI ao seu 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údo relacionado