Você está vendo a documentação do Looker 22.16. A documentação mais recente está disponível aqui.

Parâmetros de botão para painéis LookML

Para usar os parâmetros do botão, o administrador do Looker precisa ativar o recurso Botões personalizados para o painel do Labs.

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

preferred_viewer definido como dashboards-next
layout definido como newspaper

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

Para mais informações sobre como adicionar botões a um painel na IU 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 está em unidades de linhas para os painéis `layout: newspaper`
`width` (para elementos)	Define a largura da caixa de blocos de um elemento de botão. A largura está em unidades de colunas para os 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 painéis `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 painéis `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 do painel LookML de type: button, você precisa especificar valores para pelo menos os parâmetros name e type.

Os parâmetros height, width, row e col se aplicam à caixa de agrupamento de um elemento de botão, não ao próprio botão.

`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 de Parâmetros do painel.

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

O name fornecido ao botão não aparecerá na IU 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 de Parâmetros do painel.

O 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 medida.

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 painéis do LookML) para ter uma visão geral dos diferentes tipos de elementos do painel 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, descrita na página 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.

O padrão das caixas do bloco do botão é de seis linhas. A altura mínima é de 1 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 abaixo define a caixa de bloco do botão como 12 linhas:

- 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, descrito na página de documentação Parâmetros do painel.

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

A largura da caixa de bloco de um elemento de botão é padronizada como oito colunas, o que representa um terço da largura total de um painel. A largura mínima para a caixa de um botão é 2.

Por exemplo, o código abaixo define a caixa de bloco de um botão com 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 do botão vai aumentar para acomodar uma longa string de texto, definida em text. No entanto, a largura do botão não aumentará além do valor definido no parâmetro width e, 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 do painel. O padrão dos elementos do botão do painel é a altura de seis linhas. Isso significa que os elementos do painel na parte superior de um painel (row: 0) assumem, por padrão, as linhas de 0 a 5.

No exemplo a seguir, o código define a caixa de bloco de um botão a ser 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 do botão é colocada.

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

Por exemplo, o código a seguir define um elemento a ser definido na terceira coluna de elementos do 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 do painel 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.

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 na IU do painel. O botão aumenta a largura para acomodar o texto até atingir o limite definido pelo parâmetro width. Então, o texto ficará truncado.

`description`

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

`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 dentro da caixa de blocos do elemento do botão. O padrão de alignment é center.

tamanho

size define o tamanho do botão e o texto dele como small, medium ou large. O valor de size não afeta o tamanho da caixa de bloco do elemento do botão ou do 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 o texto dele, dependendo da configuração de style. O padrão é color da 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.

`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 do painel para valores específicos.

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