Como usar componentes de visualização para renderizar visualizações personalizadas

Este exemplo renderiza uma visualização personalizada que é local para um app em desenvolvimento, e não uma visualização personalizada disponível no Looker Marketplace.

Os componentes de visualização do Looker têm um sistema de adaptador que permite aos desenvolvedores substituir tipos de gráficos existentes ou adicionar opções de tipos de gráficos totalmente novos.

Essa opção pode ser útil nas seguintes circunstâncias:

  • Você criou visualizações personalizadas do React que gostaria de usar com os componentes do Looker.
  • Você quer substituir uma visualização padrão do Looker por uma que foi criada em uma biblioteca diferente.

A capacidade de substituir ou adicionar gráficos pode ser especialmente relevante se você estiver criando um aplicativo que permite aos usuários mudar o tipo de visualização de gráfico durante uma sessão.

Contexto

Depois de renderizar uma consulta na interface de Análise do Looker e transmitir o Query.client_id aos componentes de visualização do Looker, é possível modificar o tipo de gráfico atualizando a propriedade type da propriedade config.

Cada valor aceito pela propriedade type é mapeado para um componente React específico. Portanto, quando type é definido como line, um componente Line é renderizado. Quando type é definido como area, um componente Area é renderizado e assim por diante.

A propriedade chartTypeMap do componente Visualization permite adicionar uma nova entrada ou substituir as entradas atuais no mapa de tipo/componente que associa cada valor de type a um componente específico.

Requisitos

Assim como no exemplo Como usar componentes de visualização e a propriedade query para renderizar uma visualização simples, você precisa começar importando o componente DataProvider e fornecendo uma instância autenticada do SDK. O exemplo a seguir foi criado no framework de extensões do Looker, e o SDK vem de ExtensionContext.

No DataProvider, você pode renderizar os componentes Query e Visualization para solicitar dados do SDK do Looker e renderizar a visualização esperada no seu aplicativo.

A configuração é a seguinte (na propriedade query, substitua o valor pelo Query.client_id da sua consulta):

import React, { useContext } from 'react'
import { ExtensionContext } from '@looker/extension-sdk-react'
import { DataProvider } from '@looker/components-data'
import { Query, Visualization } from '@looker/visualizations'

const App = () => {
    const { core40SDK } = useContext(ExtensionContext)
    return (
        <DataProvider sdk={core40SDK}>
            <Query query="z8klgi4PJKAl7TXgTw1opS">
                <Visualization />
            </Query>
        </DataProvider>
    )
}

Como adicionar um novo tipo de gráfico

Assim como no exemplo de visualização simples, é possível modificar o tipo de gráfico renderizado transmitindo uma substituição de configuração para o componente Query.

<Query query="z8klgi4PJKAl7TXgTw1opS" config={{ type: 'pie' }}>
    <Visualization />
</Query>

Nesse caso, type foi definido como pie: um gráfico que os componentes do Looker oferecem por padrão. Mas e se você quiser usar um gráfico que não é oferecido por padrão? Nessa situação, use a propriedade chartTypeMap de Visualization para adicionar ou substituir os componentes do gráfico no mapa de tipo/componente no sistema de adaptador.

Se você quiser adicionar um novo gráfico de radar ao mapa de tipo/componente, adicione-o ao chartTypeMap desta forma:

import React, { useContext } from 'react'
import { ExtensionContext } from '@looker/extension-sdk-react'
import { DataProvider } from '@looker/components-data'
import { Query, Visualization } from '@looker/visualizations'
import { MyCustomRadar } from '../MyCustomRadar'

const App = () => {
    const { core40SDK } = useContext(ExtensionContext)
    return (
        <DataProvider sdk={core40SDK}>
            <Query query="z8klgi4PJKAl7TXgTw1opS" config={{ type: 'radar'}}>
                <Visualization chartTypeMap={{ radar: MyCustomRadar }} />
            </Query>
        </DataProvider>
    )
}

Esse código faz o seguinte:

  • Importa o componente MyCustomRadar do React
  • Atribui a chave radar à propriedade config.type.
  • Atualiza a propriedade chartTypeMap para que o sistema de mapeamento de tipos saiba o que renderizar para um type de radar

Confira como ele é renderizado no ambiente de testes de visualização do Looker:

Um mapa de radar é exibido no ambiente de testes de visualização.

Da mesma forma, você pode substituir gráficos existentes se quiser renderizar sua própria versão. No exemplo a seguir, o componente padrão do Looker o gráfico de linhas foi substituído por um componente de gráfico de linhas personalizado:

import React, { useContext } from 'react'
import { ExtensionContext } from '@looker/extension-sdk-react'
import { DataProvider } from '@looker/components-data'
import { Query, Visualization } from '@looker/visualizations'
import { MyCustomLine } from '../MyCustomLine'

const App = () => {
    const { core40SDK } = useContext(ExtensionContext)
    return (
        <DataProvider sdk={core40SDK}>
            <Query query="z8klgi4PJKAl7TXgTw1opS">
                <Visualization chartTypeMap={{ line: MyCustomLine }} />
            </Query>
        </DataProvider>
    )
}

Agora, sempre que o componente Query encontrar uma consulta em que o tipo de visualização está definido como line, ele vai renderizar a implementação personalizada no lugar do padrão do Looker.

Próximas etapas