Nesta página, descrevemos como criar um tipo de visualização personalizado que pode ser adicionado ao Looker Marketplace e acessado por outros usuários do Looker. Também é possível criar uma visualização personalizada diretamente no seu projeto sem disponibilizá-la para outros clientes do Looker.
É necessário ser membro da rede de parceiros do Looker ou um cliente do Looker para enviar conteúdo ao Marketplace do Looker.
O Looker Marketplace é um local central para encontrar, implantar e gerenciar muitos tipos de conteúdo do Looker, como Looker BlocksTM, aplicativos, visualizações e outros plug-ins.
Com o recurso Marketplace do Looker ativado, os clientes do Looker podem instalar plug-ins do Looker Marketplace, que incluem tipos de visualização a serem adicionados à biblioteca de visualização nativa do Looker. As visualizações instaladas pelo Marketplace são compatíveis com a equipe do Looker.
Para desenvolver uma visualização personalizada e disponibilizá-la a todos os clientes do Looker no Looker Marketplace, siga estas etapas:
- Desenvolva uma visualização.
- Criar um projeto do Looker para a visualização.
- Envie o projeto do Looker a um repositório Git.
- Teste a funcionalidade da visualização.
- Envie sua visualização para o Looker.
Como desenvolver um tipo de visualização
Identifique um tipo de visualização que você quer desenvolver. Confirme se essa visualização ainda não está listada no Marketplace ou como uma visualização nativa do Looker.
Desenvolva sua visualização personalizada em JavaScript usando a API Looker View com seu ambiente JavaScript.
Como criar um projeto do Looker para a visualização
Crie um projeto do Looker para representar sua visualização personalizada. O projeto precisa conter os seguintes arquivos:
Arquivo LICENSE: lista as licenças com que a visualização é distribuída, usando o texto
"Esta visualização do Looker é distribuída com a seguinte licença:...".Arquivo
README.md: fornece uma descrição da visualização, como ela funciona e outras informações.Arquivo JavaScript (
.js): contém uma versão condensada do código JavaScript que você usou para produzir sua visualização. No Marketplace, os arquivos JS estão incluídos no projeto, o que permite o controle de versões e o gerenciamento de pacotes adequados.Arquivo de manifesto (
manifest.lkml): especifica umid(um identificador exclusivo) e umlabel(mostrado na IU do Looker para essa visualização). Exemplo:
constant: vis_id {
value: "default_id"
export: override_optional
}
constant: vis_label {
value: "default_label"
export: override_optional
}
visualization: {
id: "@{vis_id}"
label: "@{vis_label}"
file: "my_local.js"
sri_hash: "my_sri_hash"
dependencies: []
}
- Arquivo de listagens (
marketplace.json): configura a ficha do Marketplace para a visualização personalizada e inclui um rótulo para a exibição da visualização no Marketplace, a localização doimage_uri, um slogan que descreve o caso de uso da visualização e também define as constantes de campo do Marketplace que os usuários inserem durante a instalação. Exemplo:
{
"label": "Gauge Visualization",
"category_label": "plug-ins",
"branding": {
"image_uri": "https://marketplace-api.looker.com/visualization-screenshots/gauge_icon.png",
"tagline": "Use the Gauge visualization to display a measure and progress to a goal."
},
"constants": {
"vis_label": {
"label": "Visualization Label",
"description": "This label will appear in the visualization selector in the Looker Explore UI."
},
"vis_id": {
"label": "Visualization Id",
"description": "This must be a unique ID across all visualizations.",
"value_constraint": "visualization"
}
}
}
Enviar o projeto para o Git
Hospede sua LookML de visualização em um repositório do GitHub acessível publicamente. Supondo que você tenha criado a visualização em um projeto do Looker, siga estas etapas para enviá-la a um novo repositório:
- Crie um repositório do GitHub acessível publicamente.
- Defina o URL do repositório do seu projeto do Looker como o URL do seu repositório do GitHub.
- Siga as instruções do Git no Looker para validar, confirmar e implantar seu código na produção.
Como testar a funcionalidade da visualização
Teste a nova visualização aplicando-a a uma exploração ou aparência adequada na sua instância do Looker:
- Navegue até o recurso "Olhar ou Explorar".
- Em um Look, clique em Edit para alterar o visual.
- Clique no menu de três pontos no menu de tipo de visualização para abrir a lista suspensa de visualizações.
- Selecione sua visualização personalizada.
- Clique em Salvar para salvar a alteração na aparência. Observe os painéis que podem ser afetados por essa mudança.
O Looker exige estas funções nas visualizações disponíveis do Looker Marketplace:
| Função | Obrigatória |
|---|---|
| Suporte para detalhamento da visualização | Yes |
| Capacidade de herdar paletas de cores do Looker | Yes |
| Receptividade ao navegador e ao tamanho da tela | Yes |
Família de fontes consistente: font-family: Helvetica, Arial, sans-serif |
Yes |
| Dimensionamento de fonte | Yes |
| Opção para alternar Rótulos de valor e Rótulos de eixo no painel de configuração de visualização | Yes |
| Visualização de dados dinâmicos | Sim (quando aplicável) |
Atualizações de visualização com base na interatividade do usuário usando a função updateAsync ou o is update. |
Yes |
Mensagens de erro claras (por exemplo, Esta visualização requer 1 dimensão e 2 medidas) |
Yes |
| Todas as opções no painel de configuração da visualização fazem uma mudança aparente na visualização. | Yes |
Uso da formatação de value do campo por padrão |
Sim (quando aplicável) |
| O erro é gerado quando uma consulta não retorna resultados | Yes |
Como enviar a visualização para análise
Quando sua visualização estiver pronta para envio, siga as instruções em Como enviar conteúdo para o Looker Marketplace para criar a documentação de suporte para sua visualização, envie sua visualização para a equipe do Looker para revisão e publique sua visualização no Looker Marketplace.