Parâmetros de botão para dashboards do LookML

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

• preferred_viewer definido como dashboards-next
• layout definido como newspaper

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

Para informações sobre como adicionar botões a um painel usando a 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 dashboards do layout: newspaper.
width (para elementos)	Define a largura da caixa de bloco de um elemento de botão. A largura está em unidades de colunas para dashboards do 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 bloco de um elemento de botão em unidades de colunas para dashboards layout: newspaper.
Parâmetro de 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 painel do LookML de type: button, especifique 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 painel.

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

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

O name atribuído ao botão não aparece 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 painel.

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

type também pode ser usado como parte de uma junção, conforme descrito na página de documentação do parâmetro type (para junções).

type também pode ser usado como parte de uma dimensão, conforme descrito na página de documentação Tipos de dimensões, filtros e parâmetros.

type também pode ser usado como parte de uma métrica, conforme descrito na página de documentação Tipos de métricas.

O parâmetro type determina o tipo de visualização a 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

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 painel.

height também pode ser usado como parte de uma linha do painel, conforme descrito 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 bloco 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 de 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 bloco do botão como 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 painel.

width também pode ser usado como parte de um painel, conforme 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 padrão da caixa de bloco de um elemento de botão é de oito colunas, o que corresponde 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 de 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 aumentar além do 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.

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

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 na 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.

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

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

- dashboard: sales_overview
  layout: newspaper
  ...

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

Parâmetro de botão

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

rich_content_json

rich_content_json é um objeto JSON com vários pares de chave/valor que definem características do botão do 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"
 }'

text

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

description

description define o texto que aparece como uma dica pop-up ao passar 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 do botão. 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 de 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 com a 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 style. color usa como padrão a primeira cor da 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.

href

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

Em uma experiência incorporada, os links para painéis precisam conter embed/ no URL.