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:

Esta página demonstra como adicionar e personalizar um elemento de dashboard do LookML de type: button com parâmetros de dashboard do LookML em um dashboard.lkml arquivo. Os botões são úteis para colocar links nos dashboards. É possível 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 dashboard pela interface do Looker, consulte a página de documentação Como criar dashboards 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 está em unidades de linhas para layout: newspaper dashboards
width (para elementos) Define a largura da caixa de bloco de um elemento de botão. A largura está em unidades de colunas para layout: newspaper dashboards
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 layout: newspaper dashboards
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, é necessário 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 name parâmetro que faz parte de um elemento do dashboard.

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

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 atribuído ao botão não vai aparecer na UI do dashboard.

- name: orders_by_date

type

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

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

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ões, filtros e parâmetros.

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

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 height parâmetro que faz parte de um elemento do dashboard.

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

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. A mudança na altura do elemento do botão pode afetar outros elementos no dashboard, 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 width parâmetro que faz parte de um elemento do dashboard.

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

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, que é um terço da largura total de um dashboard. A largura mínima para a 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 dashboard:

- 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 dashboard 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 (row: 0) vão ocupar as linhas de 0 a 5.

No exemplo a seguir, o código define a caixa de bloco de um botão para ser colocada na segunda linha de elementos no dashboard, 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 dashboards são divididos em 24 colunas. Um dashboard começa com a coluna 0 à esquerda. Um dashboard com layout de jornal tem uma largura de elemento padrão de oito colunas, o que significa que os elementos do dashboard à esquerda (col: 0) vão ocupar as colunas de 0 a 7.

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

- 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 e valor que definem as características do botão do dashboard.

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

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 de dashboard que navega para uma guia no dashboard.

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 dashboard. O botão se expande em largura para acomodar o texto até atingir o limite definido pelo width parâmetro, momento em que o texto será truncado.

description

description define o texto que aparece como uma dica de ferramenta quando você mantém 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). newTab é definido como true por padrão.

alignment

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

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 ou 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 style. color é definido como 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 dashboard tiver guias, targetTabName define a guia do dashboard para a qual o botão vai levar os usuários.

Saiba mais sobre dashboards com guias.

href

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