Parâmetros de botão para dashboards do LookML

Os botões são compatíveis apenas com dashboards do LookML com as seguintes configurações:

Nesta página, mostramos como adicionar e personalizar um elemento de dashboard do LookML de type: button com parâmetros de dashboard do LookML em um arquivo dashboard.lkml. Os botões são úteis para colocar links nos painéis. É possível vincular a conteúdo do Looker, como Looks e dashboards, ou a outros sites.

Para saber como adicionar botões a um painel pela interface do Looker, consulte a página de documentação Como criar painéis definidos pelo usuário.

Exemplo de uso


## BASIC PARAMETERS
type: button
name: text
height: N
width: N
row: N
col: N

## BUTTON PARAMETER
rich_content_json: '{
 "text": "button text",
 "description": "description",
 "newTab": true | false,
 "alignment": "left" | "right" | "center",
 "size": "small" | "medium" | "large",
 "style": "OUTLINED" | "FILLED" | "TRANSPARENT",
 "color": "hex string or css color",
 "href": "link"
 }'

Definições de parâmetro

Nome do parâmetro Descrição
Parâmetros básicos
type (para elementos) Determina o tipo de visualização a ser usado no elemento.
name (para elementos) Cria um elemento
height (para elementos) Define a altura da caixa de bloco de um elemento de botão. A altura é em unidades de linhas para painéis layout: newspaper
width (para elementos) Define a largura da caixa de bloco de um elemento de botão. A largura é em unidades de colunas para painéis layout: newspaper
row Define a posição de cima para baixo da caixa de bloco de um elemento de botão em unidades de linhas para dashboards layout: newspaper.
col Define a posição da esquerda para a direita da caixa de blocos de um elemento de botão em unidades de colunas para dashboards layout: newspaper.
Parâmetro do botão
rich_content_json Um objeto JSON que contém pares de chave-valor com informações sobre o botão.

Parâmetros básicos

Ao definir um elemento de dashboard do LookML de type: button, é preciso especificar valores para pelo menos os parâmetros name e type.

Os parâmetros height, width, row e col se aplicam à caixa de bloco de um elemento de botão, não ao botão em si.

name

Esta seção se refere ao parâmetro name que faz parte de um elemento do dashboard.

name também pode ser usado como parte de um filtro de painel, descrito na página de documentação Parâmetros do painel.

Cada declaração name cria um novo elemento do dashboard e atribui um nome a ele. Os nomes dos elementos precisam ser exclusivos.

O name fornecido ao botão não vai aparecer na interface do painel.

- name: orders_by_date

type

Esta seção se refere ao parâmetro type que faz parte de um elemento do dashboard.

type também pode ser usado como parte de um filtro de painel, descrito na página de documentação Parâmetros do painel.

type também pode ser usado como parte de uma mesclagem, descrita na página de documentação do parâmetro type (para mesclagens).

type também pode ser usado como parte de uma dimensão, descrita na página de documentação Tipos de dimensão, filtro e parâmetro.

type também pode ser usado como parte de uma medida, descrita na página de documentação Tipos de medida.

O parâmetro type determina o tipo de visualização que será usado no elemento.

- name: element_name
  type: text | looker_grid | table | single_value | looker_single_record |
        looker_column | looker_bar | looker_scatter | looker_line | looker_area |
        looker_pie | looker_donut_multiples | looker_funnel | looker_timeline |
        looker_map | looker_geo_coordinates | looker_geo_choropleth | looker_waterfall |
        looker_wordcloud | looker_boxplot | button | group

Consulte a página de documentação type (para dashboards do LookML) para uma visão geral dos diferentes tipos de elementos de dashboard do LookML.

height

Esta seção se refere ao parâmetro height que faz parte de um elemento do dashboard.

height também pode ser usado como parte de uma linha do painel, descrita na página de documentação Parâmetros do painel.

O parâmetro height define a altura da caixa de bloco de um elemento de botão, em unidades de linha.

As caixas de blocos de elementos de botão têm uma altura padrão de seis linhas. A altura mínima é de uma linha. Mudar a altura do elemento do botão pode afetar outros elementos no painel, mas não a altura do botão em si.

Por exemplo, o código a seguir define a caixa de blocos do botão como tendo 12 linhas de altura:

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    height: 12
    ...

width

Esta seção se refere ao parâmetro width que faz parte de um elemento do dashboard.

width também pode ser usado como parte de um painel, descrito na página de documentação Parâmetros do painel.

O parâmetro width define a largura da caixa de bloco de um elemento de botão, em unidades de colunas.

A largura da caixa de bloco de um elemento de botão é de oito colunas por padrão, o que equivale a um terço da largura total de um painel. A largura mínima da caixa de bloco de um botão é 2.

Por exemplo, o código a seguir define a caixa de bloco de um botão como metade da largura do painel:

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    width: 12
    ...

Se houver espaço na caixa do bloco de um botão, a largura dele vai aumentar para acomodar uma string de texto longa, que é definida em text. No entanto, a largura do botão não vai ultrapassar o valor definido no parâmetro width. Se necessário, a string definida em text será truncada no botão.

row

O parâmetro row define a linha em que a borda superior da caixa de bloco de um elemento de botão é colocada. Se o botão for colocado dentro de um grupo de blocos usando o parâmetro group, row vai definir a posição da linha do botão em relação à parte de cima do contêiner do grupo (row: 0).

Um painel começa com a linha 0 na parte de cima. Os elementos de botão do dashboard têm uma altura padrão de seis linhas, o que significa que os elementos do dashboard na parte de cima de um dashboard (row: 0) ocupam as linhas de 0 a 5 por padrão.

No exemplo a seguir, o código define que a caixa de bloco de um botão seja colocada na segunda linha de elementos no painel, supondo que os elementos estejam definidos com a altura padrão:

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    row: 6
    ...

col

O parâmetro col define a coluna em que a borda esquerda da caixa de bloco do elemento de botão é colocada. Se o botão for colocado dentro de um grupo de blocos usando o parâmetro group, col vai definir a posição da coluna do botão em relação à borda esquerda do contêiner do grupo (col: 0).

Os painéis são divididos em 24 colunas. Um painel começa com a coluna 0 à esquerda. Um dashboard com layout de jornal tem como padrão uma largura de elemento de 8 colunas, o que significa que os elementos do dashboard à esquerda de um dashboard (col: 0) ocupam as colunas de 0 a 7.

Por exemplo, o código a seguir define um elemento para ser colocado na terceira coluna de elementos no painel:

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    col: 16
    ...

Parâmetro do botão

O parâmetro descrito nesta seção pode ser usado para adicionar conteúdo a um elemento de dashboard do LookML de type: button.

rich_content_json

rich_content_json é um objeto JSON com vários pares de chave-valor que definem as características do botão do painel.

O exemplo de uso a seguir demonstra um botão de painel que navega para outro painel.

rich_content_json: '{
 "text": "Go to Sales Dashboard",
 "description": "View sales from the last 18 months.",
 "newTab": true,
 "alignment": "center",
 "size": "medium",
 "style": "FILLED",
 "color": "forestgreen",
 "href":"https://instance_name.looker.com/dashboards/152?State=California&Created+Fiscal+Quarter=2022"
 }'

O exemplo de uso a seguir demonstra um botão do painel que navega até uma guia no painel.

rich_content_json: '{
 "text": "Go to Users tab",
 "description": "View user data from the last 18 months.",
 "newTab": false,
 "alignment": "center",
 "size": "medium",
 "style": "FILLED",
 "color": "forestgreen",
 "targetTabName":"Users"
 "href":""
 }'

text

text define o texto que vai aparecer no botão na UI do painel. O botão se expande em largura para acomodar o texto até atingir o limite definido pelo parâmetro width, quando o texto é truncado.

description

description define o texto que aparece como uma dica quando você passa o cursor sobre o botão. Se nenhuma descrição for fornecida, o padrão será mostrar o link fornecido em href.

newTab

newTab é um booleano que define se o link do botão será aberto em uma nova guia (true) ou na guia atual (false). O padrão de newTab é true.

alignment

alignment define o alinhamento do botão na caixa de bloco do elemento. O padrão de alignment é center.

tamanho

size define o tamanho do botão e do texto como small, medium ou large. O valor de size não afeta o tamanho da caixa de bloco do elemento do botão nem o parâmetro height.

style

style define o estilo do botão como um dos seguintes valores:

  • FILLED: o corpo do botão é preenchido pela cor definida em color. O texto do botão é branco. Esse é o valor padrão.
  • OUTLINED: o botão tem um contorno ao redor da borda, mas o corpo é transparente. A cor do texto do botão é definida por color.
  • TRANSPARENT: o corpo do botão é transparente. A cor do texto do botão é definida por color.

color

color define a cor do botão ou do texto dele, dependendo da configuração de style. color usa como padrão a primeira cor na coleção de cores categóricas padrão da instância do Looker.

Os valores de cor podem ser formatados como strings hexadecimais, como #2ca6cd, ou como nomes de cores CSS, como mediumblue.

targetTabName

Se o painel tiver guias, targetTabName define a guia do painel para onde o botão vai direcionar os usuários.

Saiba mais sobre painéis com guias.

href

href define o URL para onde o botão vai direcionar os usuários. Os links para outros painéis do Looker podem conter parâmetros de filtro que definem os filtros do painel com valores específicos.