Parâmetros do dashboard do LookML

Há duas maneiras de criar painéis. Os painéis definidos pelo usuário são criados usando a interface do Looker e são descritos na página de documentação Como criar painéis definidos pelo usuário. Os dashboards também podem ser criados usando o LookML, e as configurações gerais deles podem ser modificadas conforme discutido nesta página.

Nesta página, descrevemos os parâmetros do dashboard do LookML que afetam todo o dashboard.

Um dashboard do LookML também contém elementos, que são as visualizações de dados, os blocos de texto, os botões e os grupos de blocos no dashboard. Consulte a página Parâmetros de elementos do dashboard para ver links para as páginas de referência de cada tipo de elemento.

Exemplo de uso

- dashboard: dashboard_name
  title: "chosen dashboard title"
  description: "chosen dashboard description"
  enable_viz_full_screen: true | false
  enabled_dashboard_agents: true | false
  default_dashboard_agent: agent_name
  extends: name_of_dashboard_being_extended
  extension: required
  layout: tile | static | grid | newspaper
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  - name: Tab 4
    label: Tab 4
  rows:
    - elements: [element_name, element_name, ...]
      height: N
  tile_size: N
  width: N
  refresh: N (seconds | minutes | hours | days)
  auto_run: true | false

  # DASHBOARD FILTER PARAMETERS
  crossfilter_enabled: true | false
  filters_bar_collapsed: true | false
  filters_location_top: true | false
  filters:
  - name: filter_name
    title: "chosen filter title"
    type: field_filter | number_filter | date_filter
    model: model_name
    explore: explore_name
    field: view_name.field_name
    default_value: Looker filter expression
    allow_multiple_values: true | false
    required: true | false
    vis_filter: true | false
    ui_config:
      type: button_group | checkboxes | range_slider | tag_list | radio_buttons |
            button_toggles | dropdown_menu | slider | day_picker | day_range_picker |
            relative_timeframes | advanced
      display: inline | popover | overflow
      options:
        min: N
        max: N
      - value options
    listens_to_filters:
    - filter_name
      field: view_name.field_name

  # EMBEDDED DASHBOARD PARAMETERS
  embed_style:
    background_color: "css_color"
    show_title: true | false
    title_color: "css_color"
    show_filters_bar: true | false
    tile_background_color: "css_color"
    tile_text_color: "css_color"

  # ELEMENTS PARAMETERS
  elements:
  # One or more element declarations
  tab_name:
  # Optional - for organizing elements onto tabs. Must be declared for each element individually.
  group:
  # Optional - for organizing elements into a tile group. Must be declared for each child element individually.

Definições de parâmetro

Nome do parâmetro	Descrição
dashboard	Criar um painel.
title (para o painel)	Mude a forma como o nome de um painel aparece para os usuários.
description (para o painel)	Adicione uma descrição que pode ser vista no painel Detalhes do dashboard ou em uma pasta definida com o modo de visualização em lista.
enable_viz_full_screen	Defina se os leitores do dashboard podem ver os blocos em tela cheia e visualizações expandidas.
enabled_dashboard_agents	Defina se os leitores do dashboard podem conversar com o dashboard do LookML usando um agente de dashboard.
default_dashboard_agent	Especifique o agente padrão do painel a ser usado para consultas de conversação no painel.
extends	Baseia o dashboard do LookML em outro dashboard do LookML.
extension	Exige a extensão do painel com outro painel.
layout	Define como os elementos são organizados no dashboard.
tabs	Adição da versão 26.4 Adiciona guias do painel para organizar os elementos em um painel. Precisa ser usado com o parâmetro tab_name para que os elementos especifiquem em qual guia um elemento vai aparecer.
rows	Inicie uma seção do LookML para definir os elementos que devem ser incluídos em cada linha de um dashboard layout: grid.
elements (para linhas)	Defina os elementos que devem ser incluídos em uma linha de um painel layout: grid.
height (para linhas)	Define a altura de uma linha em um dashboard layout: grid.
tile_size	Define o tamanho de um bloco em um dashboard layout: tile.
width (para o painel)	Define a largura do dashboard para um dashboard layout: static.
refresh (para o painel)	Defina o intervalo em que os elementos do dashboard serão atualizados automaticamente.
auto_run	Determina se os dashboards são executados de modo automático quando são abertos ou recarregados.
Parâmetros de filtro
crossfilter_enabled	Ativar ou desativar o cruzamento de filtros em um painel.
filters_bar_collapsed	Defina a barra de filtros do painel como recolhida ou expandida por padrão.
filters_location_top	Defina o local da barra de filtros do painel como superior ou direito.
filters (para o painel)	Inicia uma seção do LookML para definir filtros de painel.
name (para filtros)	Criar um filtro.
title (para filtros)	Mude a forma como o nome de um filtro aparece para os usuários.
type (para filtros)	Determine o tipo de filtro que será usado.
default_value	Defina um valor padrão para um filtro.
allow_multiple_values	Limitar os usuários a um único valor de filtro.
required	Exigir que os usuários insiram um valor de filtro para executar o painel.
ui_config	Configure os controles de filtro disponíveis quando os usuários visualizam um dashboard do LookML. Tem os subparâmetros type, display e options.
model (para filtros)	(Opcional) Especifique o modelo que contém o campo subjacente de um filtro type: field_filter.
explore (para filtros)	Especifique a Análise que contém o campo subjacente de um filtro type: field_filter.
field	Especifique o campo subjacente de um filtro type: field_filter.
listens_to_filters	Restringir as sugestões para filtros de painel de field_filter com base no que o usuário insere para outros filtros de painel de type: field_filter.
vis_filter	Configure um filtro para aparecer diretamente em um bloco de visualização, em vez de na barra de filtros do painel.
Parâmetros de painel incorporado
embed_style	Inicia uma seção do LookML para definir personalizações de dashboards incorporados.
background_color	Defina uma cor de plano de fundo para um painel incorporado.
show_title	Especifica se o título do painel é visível em um painel incorporado.
title_color	Defina a cor do título de um painel incorporado.
show_filters_bar	Especifica se a barra de filtros fica visível em um painel incorporado.
tile_background_color	Defina a cor do plano de fundo do bloco de um painel incorporado.
tile_text_color	Defina a cor do texto do bloco de um painel incorporado.
Parâmetros de elemento
elements (para o painel)	Inicia uma seção do LookML para definir elementos do dashboard.
group (para elementos)	Organize os elementos do dashboard em um grupo de blocos especificando o nome de um elemento type: group.

dashboard

O parâmetro dashboard declara um novo painel e especifica um nome para ele. O número máximo de caracteres é 255, e os caracteres permitidos são letras (A-Z), números (0-9), hífens (-) e sublinhados (_). Normalmente, a prática recomendada é colocar cada dashboard do LookML no próprio arquivo do LookML, mas é possível declarar vários dashboards em um único arquivo.

- dashboard: sales_overview

Para exibir qualquer coisa, um painel precisa de pelo menos um elemento adicionado usando o parâmetro elements.

Observação: se você mudar o valor do parâmetro dashboard de um dashboard do LookML que foi removido da pasta Dashboards do LookML, ele será movido automaticamente de volta para a pasta Dashboards do LookML.

preferred_viewer (obsoleto)

Importante: esse parâmetro é ignorado.

Antes da descontinuação do dashboard legado no Looker 23.6, o parâmetro preferred_viewer permitia escolher o formato para visualizar e baixar um dashboard como a experiência de dashboard padrão do Looker ou como um dashboard legado.

title (para o painel)

Observação: esta seção se refere ao parâmetro title que faz parte de um painel.

title também pode ser usado como parte de um filtro de painel, descrito na seção title (para filtros) nesta página.

title também pode ser usado como parte de qualquer elemento do dashboard. Um exemplo representativo do uso dele é fornecido na página de documentação Elementos do gráfico de colunas.

O parâmetro title permite mudar como o nome de um dashboard aparece para os usuários em pastas e na parte de cima do dashboard. Se não for especificado, o título padrão será o nome do painel. O texto do título pode ser localizado.

Por exemplo,

- dashboard: sales_overview
  title: "1) Sales Overview"

Se você fizer isso, em vez de o painel aparecer como Visão geral de vendas, ele vai aparecer como 1) Visão geral de vendas.

description (para o painel)

Observação: esta seção se refere ao parâmetro description que faz parte de um painel.

description também pode ser usado como parte de uma Análise, conforme descrito na página de documentação do parâmetro das Análises description.

description também pode ser usado como parte de um campo, conforme descrito na página de documentação do parâmetro description (para campos).

O parâmetro description permite adicionar uma descrição a um dashboard do LookML.

O conteúdo do parâmetro description vai aparecer no campo Descrição do painel Detalhes do dashboard de um dashboard do LookML.

A descrição é exibida abaixo do título do dashboard nas listas de dashboards quando visualizadas em uma pasta definida com o modo de visualização em lista. Se uma descrição não for especificada, a lista vai mostrar apenas o título do painel.

O texto da descrição pode ser localizado.

enable_viz_full_screen

Esse parâmetro só entra em vigor quando a configuração Visualizações em tela cheia é ativada por um administrador do Looker. A configuração Visualização em tela cheia é ativada por padrão.

O parâmetro enable_viz_full_screen permite definir se os leitores do dashboard podem ver os blocos em tela cheia e visualizações expandidas. É equivalente à configuração de painel Permitir o modo de tela cheia nas visualizações.

Esse parâmetro aceita os valores true (visualizações em tela cheia e expandidas disponíveis) e false (visualizações em tela cheia e expandidas indisponíveis). O valor padrão é true.

enabled_dashboard_agents

O parâmetro enabled_dashboard_agents permite controlar se os leitores do dashboard podem conversar com o dashboard do LookML usando um agente de dashboard.

Esse parâmetro só entra em vigor quando a configuração Agentes de painel está ativada para sua instância do Looker na página Administrador do Gemini no Looker.

Esse parâmetro aceita true (chat ativado) e false (chat desativado). Se esse parâmetro for omitido do arquivo do dashboard do LookML, o padrão será true na camada da API.

- dashboard: sales_overview
  enabled_dashboard_agents: true

default_dashboard_agent

O parâmetro default_dashboard_agent especifica o nome do agente de dashboard padrão a ser associado ao dashboard do LookML. O agente especificado precisa ser declarado usando o parâmetro LookML agent.

Quando os leitores iniciam uma conversa com o painel, as configurações do agente padrão, como o modo de raciocínio e a exibição de informações de depuração, são aplicadas à conversa.

- dashboard: sales_overview
  default_dashboard_agent: sales_overview_agent

Se enabled_dashboard_agents for true e default_dashboard_agent não for especificado, os usuários ainda poderão conversar com o painel usando as configurações padrão sem instruções personalizadas.

extends

Como descrito na página de documentação Como reutilizar códigos com extensões, o parâmetro extends permite basear um dashboard do LookML em outro, possivelmente adicionando ou substituindo algumas configurações. O parâmetro extends aceita o nome de outro dashboard do LookML.

Atenção: ao estender um objeto, as regras de localização também se aplicam às suas extensões. Se você estiver estendendo um objeto e definindo novos rótulos ou descrições, forneça definições de localização nos arquivos de strings de localidade do projeto. Consulte a página de documentação Como localizar seu modelo do LookML para mais informações.

extension

Conforme descrito na página de documentação Como reutilizar código com extends, o parâmetro extension indica que o dashboard precisa ser estendido por outro dashboard. Esse painel nunca fica visível para outros usuários, mas pode ser usado como modelo para criar outros painéis que ficam visíveis para outros usuários. O parâmetro extension aceita apenas o valor required. Se o parâmetro extension não for incluído, a extensão não será necessária para o painel.

layout

O parâmetro layout define o método de layout que o Looker vai usar ao posicionar os elementos do dashboard. Ele aceita os seguintes valores:

• newspaper: os elementos do dashboard vão aparecer em uma grade de 24 colunas. O tamanho padrão de um elemento é uma largura de 8 colunas e uma altura de 6 linhas. Os elementos são configuráveis ao longo dessa grade, especificados pelos parâmetros de elemento width, height, row e col. Essa opção de layout é usada quando um painel definido pelo usuário é convertido em um dashboard do LookML, além de ser o layout padrão quando um novo dashboard do LookML é criado pelo ambiente de desenvolvimento integrado do Looker. newspaper é o único layout que aceita guias do painel e grupos de blocos. Além disso, newspaper e grid são os únicos layouts que aceitam conversão de um dashboard do LookML em um painel definido pelo usuário.

• grid: os elementos do dashboard vão aparecer com larguras dinâmicas, que são baseadas em um conjunto de linhas que você define com o parâmetro rows e os subparâmetros elements e height. newspaper e grid são os únicos layouts que aceitam a conversão de um dashboard do LookML em um painel definido pelo usuário.

• static: os elementos do dashboard vão aparecer na ordem em que estão listados no arquivo do LookML. Cada elemento do dashboard precisa ser posicionado manualmente usando os parâmetros top e left. Esses parâmetros se aplicam a todos os tipos de elementos, e os detalhes sobre o uso deles aparecem nas páginas de documentação de cada tipo de visualização. Para exemplos representativos de como top e left funcionam, consulte a página de documentação Parâmetros de gráfico de colunas para dashboards do LookML. O static não é compatível com a conversão de um dashboard do LookML em um painel definido pelo usuário.

• tile: os elementos do dashboard vão aparecer na ordem em que estão listados no arquivo do LookML. A largura do painel é dinâmica e se baseia na largura do navegador. Os elementos do dashboard se posicionam dinamicamente no navegador para preencher o espaço disponível. O tile não é compatível com a conversão de um dashboard do LookML em um painel definido pelo usuário.

tabs

Adiciona guias para organizar elementos em painéis. tabs define o número, os nomes e os rótulos das guias que aparecem nos painéis. Os elementos são organizados nas guias do dashboard com o parâmetro tab_name.

Importante: os painéis com guias são compatíveis apenas com o método de layout de painel newspaper.

- dashboard: sales_overview
  layout: tile
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  - name: Tab 4
    label: Tab 4

tab_name

Especifica em qual guia do painel um elemento vai aparecer. tab_name precisa ser especificado para cada elemento individual.

- dashboard: sales_overview
  layout: tile
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  - name: Tab 4
    label: Tab 4
  elements:
  - name: order_count
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.count]
    tab_name: Tab 1

rows

Para dashboards layout: grid, o parâmetro rows inicia a seção do LookML em que você define quais elementos devem ir em quais linhas, bem como a altura de cada linha. Em cada linha, todos os elementos têm a mesma largura. Se você não listar um elemento nesta seção, ele não vai aparecer no painel.

- dashboard: sales_overview
  layout: grid
  rows:
    - elements: [element_name, element_name, ...]
      height: 200
    - elements: [element_name, element_name, ...]
      height: 300

elements

O parâmetro elements usa uma lista de nomes de elementos do dashboard, separados por vírgulas. Cada declaração elements cria uma nova linha no painel. Os elementos colocados em uma linha terão a mesma largura. Portanto, se você colocar 2 elementos em uma linha, cada um deles ocupará 50% do espaço disponível. Se você colocar 4 elementos em uma linha, cada um deles vai ocupar 25% do espaço disponível.

height

O parâmetro height define a altura de uma linha em pixels. O valor padrão é 300.

tile_size

Para painéis layout: tile e layout: static, a unidade usada para dimensionar e posicionar elementos é o tamanho do bloco. Você define tile_size em pixels, e o valor padrão é 160. Exemplo:

- dashboard: sales_overview
  layout: tile
  tile_size: 100

Nessa situação, um elemento do dashboard com height: 5 e width: 3 terá 500 pixels de altura e 300 pixels de largura. Os parâmetros height e width se aplicam a todos os tipos de elementos, e os detalhes sobre o uso deles aparecem nas páginas de documentação de cada tipo de visualização. Para um exemplo representativo de como height e width funcionam, consulte a página de documentação Parâmetros de gráfico de colunas para dashboards do LookML.

width

Observação: esta seção se refere ao parâmetro width que faz parte de um painel.

width também pode ser usado como parte de um elemento do dashboard. Um exemplo representativo do uso dele é fornecido na página de documentação para elementos de gráfico de colunas.

Para painéis layout: static, o parâmetro width define a largura total do painel que você planeja usar em pixels. O parâmetro width não vai restringir o painel a um determinado tamanho se você definir um elemento muito grande ou muitos elementos em uma linha. Em vez disso, a configuração width ajuda a manter o painel centralizado na tela. Se você não definir uma largura, o padrão será 1200.

- dashboard: sales_overview
  layout: static
  width: 800

refresh

Observação: esta seção se refere ao parâmetro refresh que faz parte de um painel.

refresh também pode ser usado como parte de um elemento do dashboard. Um exemplo representativo do uso dele é fornecido na página de documentação para elementos de gráfico de colunas.

O parâmetro refresh permite que um painel seja recarregado automaticamente de forma periódica, recuperando dados novos. Isso costuma ser útil em configurações em que um painel é exibido constantemente, como em uma TV de escritório. O painel precisa estar aberto em uma janela do navegador para que esse parâmetro tenha efeito. Essa configuração não é executada em segundo plano para "pré-aquecer" o cache do painel.

A taxa de atualização pode ser qualquer número (sem decimais) de segundos, minutos, horas ou dias. Exemplo:

- dashboard: sales_overview
  refresh: 2 hours

Tenha cuidado ao definir intervalos de atualização curtos. Como os painéis podem conter muitas consultas, algumas das quais podem exigir muitos recursos, certos painéis podem sobrecarregar o banco de dados.

auto_run

O parâmetro auto_run determina se um dashboard será executado quando for aberto ou recarregado pela primeira vez. O valor padrão é true. Quando esse parâmetro é definido como false, os usuários precisam pressionar um botão Executar para carregar o painel. Por exemplo, um painel como este será executado automaticamente quando aberto:

- dashboard: sales_overview
  auto_run: true

Independentemente da configuração de auto_run, os usuários sempre precisam clicar no botão Executar depois de mudar os valores do filtro. Isso ajuda a evitar recarregamentos indesejados quando um usuário pausa durante uma mudança de filtro ou quer mudar vários filtros ao mesmo tempo.

crossfilter_enabled

O parâmetro crossfilter_enabled permite ativar ou desativar os filtros cruzados em um painel. Quando esse parâmetro é definido como true, os leitores do painel podem criar filtros cruzados clicando em determinados pontos de dados.

- dashboard: sales_data
  crossfilter_enabled: true

filters_bar_collapsed

O parâmetro filters_bar_collapsed permite definir a barra de filtros do painel como recolhida ou expandida por padrão. Quando esse parâmetro é definido como true, a barra de filtros fica recolhida por padrão. Os leitores do painel podem expandir a barra de filtros clicando no ícone de filtros. O padrão para essa configuração é false.

- dashboard: sales_data
  filters_bar_collapsed: true

filters_location_top

O parâmetro filters_location_top permite colocar a barra de filtro do painel na parte de cima ou à direita de um painel. Quando esse parâmetro é definido como true, a barra de filtro aparece na parte de cima do painel. Quando é definido como false, ela aparece à direita do painel. O padrão para essa configuração é true.

- dashboard: sales_data
  filters_location_top: false

filters

Observação: esta seção se refere ao parâmetro filters que faz parte de um painel.

filters também pode ser usado como parte de um elemento do dashboard. Um exemplo representativo do uso dele é fornecido na página de documentação para elementos de gráfico de colunas.

filters também pode ser usado como parte de uma medição, descrita na página de documentação do parâmetro filters.

O parâmetro filters inicia a seção do LookML em que você define os filtros do dashboard. Os filtros aparecem na parte de cima do dashboard e permitem que os usuários alterem os dados por trás dos elementos do dashboard.

Para que um filtro afete um elemento, ele precisa ser configurado para "escutar" esse filtro usando o parâmetro listen. Esse parâmetro se aplica a todos os tipos de elemento, exceto type: text, type: button e type: group. Para um exemplo representativo de como o listen funciona, consulte a página de documentação Parâmetros de gráfico de colunas para dashboards do LookML.

Observação: para elementos do dashboard que usam o parâmetro merged_queries, cada consulta de origem pode detectar um ou mais filtros do dashboard. Em uma definição de consulta combinada, é possível usar o parâmetro listen para definir a lógica de filtro de cada consulta de origem de forma independente, independentemente do número de consultas de origem no elemento de resultados combinados. Se uma consulta não tiver um parâmetro listen, ela não será afetada por nenhum filtro do painel.

Quando os filtros são aplicados a um elemento dessa maneira, o tipo de filtro precisa corresponder ao tipo de dimensão ou medida que está detectando o filtro. Consulte Como criar dashboards do LookML para mais detalhes.

Observação: não defina dois ou mais filtros com a mesma combinação de name e title em um dashboard do LookML. A validação do LookML não sinaliza essa configuração duplicada, e o dashboard é renderizado normalmente. No entanto, a duplicação faz com que as operações "copiar dashboard do LookML " e"importar dashboard " falhem com um erro (por exemplo, "Falha ao copiar o dashboard"). Se você encontrar esse problema, revise a definição do LookML do dashboard para verificar se todas as configurações de nome e título do filtro são exclusivas.

Os filtros têm o seguinte formato:

filters:
- name: filter_name
  title: "chosen filter title"
  type: field_filter | number_filter | date_filter
  model: model_name
  explore: explore_name
  field: view_name.field_name
  default_value: Looker filter expression
  allow_multiple_values: true | false
  required: true | false
  vis_filter: true | false
  listens_to_filters:
  - filter_name
    field: view_name.field_name

name

Observação: esta seção se refere ao parâmetro name que faz parte de um filtro de painel.

name também pode ser usado como parte de um elemento do dashboard. Um exemplo representativo do uso dele é fornecido na página de documentação para elementos de gráfico de colunas.

Cada declaração name cria um novo filtro de painel e atribui um nome a ele. O nome será referenciado no parâmetro listen dos elementos que serão afetados pelo filtro. O parâmetro listen se aplica a todos os tipos de elementos, exceto type: text, type: button e type: group. Os detalhes sobre o uso dele aparecem nas páginas de documentação de cada tipo de visualização. Para um exemplo representativo de como listen funciona, consulte a página de documentação Parâmetros de gráfico de colunas para dashboards do LookML.

filters:
- name: order_date

title (para filtros)

Observação: esta seção se refere ao parâmetro title, que faz parte de um filtro de painel.

title também pode ser usado como parte de um painel, conforme descrito na seção title (para painel) nesta página.

title também pode ser usado como parte de um elemento do dashboard. Um exemplo representativo do uso dele é fornecido na página de documentação Parâmetros de gráfico de colunas para dashboards do LookML.

O parâmetro title permite mudar como o nome de um filtro aparece para os usuários na parte de cima de um dashboard. Se não for especificado, o título padrão será o nome do filtro.

Por exemplo,

filters:
- name: order_date
  title: "Order Date(s)"

Se você fizesse isso, em vez de o filtro aparecer como Data do pedido, ele apareceria como Datas do pedido.

type

Observação: esta seção se refere ao parâmetro type que faz parte de um filtro de painel.

type também pode ser usado como parte de um elemento do dashboard, descrito na página de documentação do parâmetro type (para dashboards do LookML).

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

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 especifica o tipo de entrada que será colocado no filtro. type: field_filter geralmente deve ser sua escolha padrão, porque ele conecta o filtro diretamente a uma dimensão ou medida subjacente e fornece um widget de filtro personalizado para o usuário. Os tipos de filtro são os seguintes:

• field_filter: geralmente deve ser sua escolha padrão, quando você pode especificar uma dimensão ou medida subjacente. Usar type: field_filter e associar o filtro a um campo type:string faz com que o filtro sugira possíveis valores.
• number_filter: permite que o usuário insira um número, um valor inteiro ou uma expressão.
• date_filter: permite que o usuário insira um valor de data ou uma expressão.

• string_filter (descontinuado): o tipo string_filter não é mais compatível desde que a experiência do painel legado foi descontinuada no Looker 23.6. Consulte as notas da versão para mais informações. Se você quiser um filtro de entrada de texto de formato livre sem uma lista suspensa de sugestões, consulte o exemplo usando field_filter.

field_filter

Sugere opções para escolher e muda a apresentação para os usuários com base no campo subjacente que você especificar.

Esse deve ser o tipo de filtro padrão em situações em que você quer fazer sugestões aos usuários enquanto eles interagem com o filtro. A dimensão de onde as sugestões serão extraídas é definida usando os parâmetros explore e field, e precisa ser um campo de type: string para gerar sugestões de filtro.

As sugestões podem não funcionar se o campo for de uma tabela derivada, se sql_always_where for usado na Análise ou se o campo for uma medida.

Veja a seguir um exemplo de LookML para um tipo field_filter:

filters:
- name: order_date
  type: field_filter
  explore: orders
  field: orders.order_date  # must be of the form view_name.dimension_name

Se você quiser um filtro de entrada de texto de formato livre sem uma lista suspensa de sugestões, use type: field_filter e configure o tipo de controle usando ui_config: type: advanced (consulte Configuração da interface).

O exemplo a seguir mostra um filtro que usa entrada de texto de forma livre sem sugestões:

filters:
- name: customer_name
  type: field_filter
  explore: orders
  field: customer.name
  ui_config:
    type: advanced

number_filter

Não faz sugestões, permite que o usuário insira um valor ou expressão de número inteiro ou número.

filters:
- name: order_value
  type: number_filter

date_filter

Não faz sugestões, permite que o usuário insira um valor ou uma expressão de data.

filters:
- name: order_date
  type: date_filter

default_value

O parâmetro default_value permite especificar um valor padrão para um filtro. Esse valor pode ser útil para os usuários, sugerindo um ponto de partida razoável.

O valor padrão precisa corresponder ao tipo de filtro usado. Exemplo:

filters:
- name: order_value
  type: number_filter
  default_value: "50 to 100"

- name: order_date
  type: date_filter
  default_value: "last 30 days"

- name: customer_name
  type: field_filter
  explore: orders
  field: customer.name
  default_value: "John Doe"

É possível usar expressões de filtro para criar valores padrão. A página de documentação Expressões de filtro do Looker descreve isso em mais detalhes.

Quando você usa os parâmetros default_value e ui_config, as expressões de filtro precisam ser compatíveis com o valor fornecido ao subparâmetro type de ui_config e os tipos de dados que aceitam o valor type.

Também é possível usar as variáveis líquidas _localization e _user_attributes para valores de filtro padrão flexíveis.

allow_multiple_values

O parâmetro allow_multiple_values permite controlar se os usuários podem selecionar um ou vários valores de filtro. Quando esse parâmetro é definido como true (o padrão), os usuários podem selecionar vários valores para o filtro. Quando esse parâmetro é definido como false, os usuários podem selecionar apenas um valor de filtro.

Exemplo:

filters:
- name: Order ID
  title: Order ID
  type: field_filter
  allow_multiple_values: true
  required: false
  model: thelookstore
  explore: orders
  field: orders.id

required

O parâmetro required permite que você exija que os usuários forneçam um valor para o filtro para executar o dashboard. Por padrão, os filtros não exigem valores. Se um filtro que não exige um valor for deixado em branco, os dados não serão restritos pelo campo do filtro. Se um filtro que exige um valor for deixado em branco, o dashboard não será executado.

filters:
  - name: State
    title: State
    type: field_filter
    required: true

ui_config

O subparâmetro ui_config de filters permite definir as configurações de filtro de um dashboard do LookML. Essas configurações incluem os tipos de controles de filtro usados, o posicionamento deles e os valores de filtro possíveis.

Exemplo:

  filters:
  - name: City
    title: City
    type: field_filter
    default_value: San Francisco
    allow_multiple_values: true
    required: false
    ui_config:
      type: button_group
      display: inline
      options:
      - San Francisco
      - New York
      - Tokyo
    model: thelook
    explore: order_items
    field: users.city

Consulte a página de documentação Como adicionar e editar filtros de painel definidos pelo usuário para mais informações sobre como configurar filtros com a UI.

type

O subparâmetro type de ui_config permite especificar os tipos de controles de filtro que são mostrados.

Dependendo do valor inserido para type, os controles de filtro podem ser de seleção única ou múltipla.

Observação: os valores aceitos por type dependem dos dados do LookML type atribuídos ao campo que você está filtrando.

STR = compatível com o tipo de dados string	DIST = compatível com o tipo de dados distance
NUM = compatível com o tipo de dados number e as medições numéricas	DUR = compatível com o tipo de dados duration
TIER = compatível com o tipo de dados tier	D&T = compatível com a maioria dos tipos de dados de data e hora
ZIP: compatível com o tipo de dados zipcode	LOC = compatível com o tipo de dados location
S/N = compatível com o tipo de dados yesno	PAR = compatível com o parâmetro parameter

Valor	Descrição	Tipos de dados compatíveis
Seleção múltipla
button_group	O filtro mostra um grupo de botões, com um botão para cada valor especificado com o parâmetro options.	STR NUM TIER ZIP Y/N DIST DUR
checkboxes	O filtro mostra caixas de seleção, uma para cada valor especificado com o parâmetro options.	STR NUM TIER ZIP Y/N DIST DUR
tag_list	O filtro mostra uma lista suspensa com cada valor possível especificado usando o parâmetro options.	STR NUM TIER ZIP DIST DUR
range_slider	Para campos numéricos, o filtro mostra um controle deslizante que permite aos usuários definir um intervalo de números como o valor do filtro. Os subparâmetros min e max de options são usados para especificar os valores mínimo e máximo possíveis para o filtro, e o intervalo padrão pode ser especificado usando o parâmetro default_value.	NUM DIST DUR
Seleção única
button_toggles	O filtro mostra um grupo de botões, com um botão para cada valor especificado com o parâmetro options.	STR NUM TIER ZIP Y/N DIST DUR PAR
radio_buttons	O filtro mostra botões de opção, com um botão para qualquer valor e um botão para cada valor especificado com o parâmetro options.	STR NUM TIER ZIP Y/N DIST DUR PAR
dropdown_menu	O filtro mostra um menu suspenso com cada valor possível especificado usando o parâmetro options. O menu suspenso também oferece aos usuários a opção de selecionar Qualquer valor.	STR NUM TIER ZIP Y/N DIST DUR PAR
slider	Para campos numéricos, o filtro mostra um controle deslizante que permite aos usuários escolher um filtro deslizando entre os valores mínimo e máximo possíveis, que são especificados usando o parâmetro options.	NUM DIST DUR
Datas e horas
day_picker	O filtro permite que os usuários escolham uma data específica para filtrar.	D&T O controle de um único dia pode ser usado com a maioria dos períodos e tipos baseados em tempo, mas os leitores só podem selecionar datas únicas com esse tipo de controle.
day_range_picker	O filtro permite que os usuários selecionem uma data de início e uma data de término para filtrar um período. Observação: quando um dashboard do LookML é carregado por um favorito do navegador, os controles de filtro configurados com type: day_range_picker não preservam nem renderizam corretamente os parâmetros de URL e o estado do filtro. Por exemplo, a data de término é deslocada incorretamente em um dia na UI. Para resolver essa inconsistência, atualize a definição do LookML do filtro mudando o tipo ui_config para advanced. Veja o exemplo a seguir: ui_config: type: advanced display: inline	D&T O controle de período pode ser usado com a maioria dos períodos e tipos baseados em tempo, mas os leitores só podem selecionar os períodos que têm esse tipo de controle.
date_time_range_input	O filtro permite que o usuário filtre por um intervalo de datas e horários.	D&T: o controle de período de data e hora pode ser usado com a maioria dos tipos baseados em tempo, e os leitores precisam selecionar as opções de data e hora com esse tipo de controle.
relative_timeframes	O filtro permite que o usuário filtre um período personalizado ou escolha entre períodos predefinidos, como Hoje, Últimos 7 dias ou Últimos 90 dias.	D&T O controle de período pode ser usado com a maioria dos períodos e tipos baseados em tempo, mas os leitores não podem selecionar opções de tempo com esse tipo de controle.
Outro
advanced	O filtro apresenta opções para aplicar um ou mais filtros ou filtros de correspondências avançadas. Consulte a seção Como usar controles avançados nesta página para saber mais sobre eles.	STR NUM TIER ZIP Y/N D&T DIST DUR LOC PAR

Observação: alguns períodos e tipos baseados em tempo são interpretados como tipos de dados diferentes quando o Looker cria opções de controle para eles. Dois exemplos são o período yesno, que é interpretado como um tipo de dados yesno e, portanto, aceita os valores compatíveis com o tipo yesno, e o período hour_of_day, que é interpretado como um tipo de dados number e, portanto, aceita os valores compatíveis com o tipo number.

display

Use o subparâmetro display de ui_config para definir a posição de um filtro de dashboard. Para posicionar um filtro, atribua um dos seguintes valores a display:

• inline: o filtro é exibido diretamente na barra de cima do painel.
• popover: um valor de resumo aparece na barra superior do painel. Clique no valor para ver o filtro completo.
• overflow: um botão Mais aparece na barra superior do painel com um indicador numérico de quantos filtros de estouro existem. Os usuários podem clicar no botão para ver os filtros de estouro e os valores deles.

Alguns tipos de filtro só podem ser exibidos de determinadas maneiras. Por exemplo, os filtros de type: day_picker só podem ser exibidos como inline ou overflow. Se você atribuir a um filtro um valor de display que não seja válido para esse type, o filtro será exibido como inline ou popover, o que for válido. Para saber mais, consulte a página de documentação Como adicionar e editar filtros de painéis definidos pelo usuário.

Para saber como posicionar filtros de dashboard usando a UI, consulte a página de documentação Como adicionar e editar filtros definidos pelo usuário.

options

O subparâmetro opcional options de ui_config permite especificar os valores que um usuário pode escolher para atualizar temporariamente os valores de filtro do dashboard ao visualizar um dashboard do LookML. Se você não especificar nenhum valor para options, o Looker vai extrair os primeiros valores do banco de dados.

Por exemplo, é possível definir San Francisco, New York e Tokyo como os valores possíveis para um filtro no campo users.city da seguinte maneira:

ui_config:
  type: button_group
  display: inline
  options:
  - San Francisco
  - New York
  - Tokyo

Se o subparâmetro type de ui_config estiver definido como range_slider ou slider, use os subparâmetros min e max de options:

• min: define o valor mínimo possível para um filtro.
• max: define o valor máximo possível para um filtro.

Exemplo:

ui_config:
  type: range_slider
  display: inline
  options:
    min: 0
    max: 500

model

Para filtros de dashboard de type: field_filter, o parâmetro model define o modelo do campo que você quer usar. O parâmetro model é opcional e usa como padrão o modelo em que o painel está incluído.

filters:
- name: State
  title: State
  type: field_filter
  default_value: California
  model: thelookstore
  explore: users
  field: users.state

explore

Observação: esta seção se refere ao parâmetro explore, que faz parte de um filtro de painel.

explore também pode ser usado como parte de um modelo, descrito na página de documentação do parâmetro explore.

explore também pode ser usado como parte de um elemento do dashboard. Um exemplo representativo do uso dele é fornecido na página de documentação para elementos de gráfico de colunas.

Para filtros de painel de type: field_filter, é preciso definir um campo de onde o filtro vai extrair sugestões. O parâmetro explore especifica qual Análise contém o campo que você quer usar.

filters:
- name: order_date
  type: field_filter
  explore: orders
  field: orders.order_date

field

Para filtros de painel de type: field_filter, é preciso definir um campo de onde o filtro vai extrair sugestões. O parâmetro field especifica qual campo você quer usar. É importante usar o nome do campo com escopo completo. Em outras palavras, use view_name.field_name, não apenas field_name.

filters:
- name: order_date
  type: field_filter
  explore: orders
  field: orders.order_date

listens_to_filters

Para filtros de painel de type: field_filter, é possível restringir as sugestões para o filtro com base no que o usuário insere em outro filtro de type: field_filter.

No exemplo a seguir, as sugestões fornecidas para o filtro State serão baseadas nos valores do filtro Order ID. Os valores selecionados para o filtro Order ID terão valores users.state associados, que serão sugeridos para o filtro State. Para mais informações, consulte a página de documentação Como adicionar e editar filtros de painéis definidos pelo usuário.

filters:
- name: State
  title: State
  type: field_filter
  model: thelookstore
  explore: users
  listens_to_filters:
  - Order ID
  field: users.state

vis_filter

Observação: esse recurso está em pré-lançamento.

O parâmetro vis_filter permite configurar um filtro como um filtro no nível da visualização que aparece diretamente em blocos de visualização individuais, em vez de na barra de filtros do painel superior.

Quando vis_filter é definido como true, o filtro aparece na barra de filtros na parte de cima de qualquer bloco que o detecte (configurado usando o parâmetro listen no elemento do dashboard). O valor padrão é false, que mostra o filtro como um filtro padrão no nível do painel na barra de filtros superior. A configuração vis_filter: false não é necessária para filtros de painel padrão.

Exemplo:

filters:
- name: order_date
  title: "Order Date"
  type: date_filter
  default_value: "last 30 days"
  vis_filter: true

Para mais informações sobre filtros no nível da visualização, consulte a página de documentação Filtros em blocos de visualização.

embed_style

O parâmetro embed_style inicia a seção do LookML em que você personaliza a aparência de um dashboard incorporado. embed_style e os parâmetros associados são compatíveis apenas com dashboards incorporados e são ignorados se o dashboard não estiver incorporado.

Depois de fazer mudanças em embed_style, você precisa implantar o LookML na produção para que as configurações de embed_style sejam refletidas no dashboard do LookML incorporado.

Para os seguintes atributos de painel incorporado que especificam uma cor, o valor da cor pode ser uma string hexadecimal, como #2ca6cd, ou uma string de cor nomeada CSS, como mediumblue.

As personalizações de dashboards incorporados têm o seguinte formato:

embed_style:
  background_color: "css_color"
  show_title: true | false
  title_color: "css_color"
  show_filters_bar: true | false
  tile_background_color: "css_color"
  tile_text_color: "css_color"

background_color

Define a cor do plano de fundo de um painel incorporado.

embed_style:
  background_color: "#ffffff"

show_title

Especifica se o título do painel incorporado fica visível para os usuários.

embed_style:
  show_title: false

title_color

Define a cor do título de um painel incorporado.

embed_style:
  title_color: "#008000"

show_filters_bar

Especifica se os filtros do painel incorporado estão visíveis para os usuários.

Observação: esse parâmetro afeta apenas a aparência do painel, não a capacidade do usuário de acessar dados. Ocultar a barra de filtros NÃO impede que os usuários mudem os filtros de outras formas. Para saber como configurar políticas seguras de controle de acesso a dados, consulte a página de documentação Controle de acesso e gerenciamento de permissões.

embed_style:
  show_filters_bar: true

tile_background_color

Define a cor do plano de fundo de todos os blocos em um painel incorporado.

embed_style:
  tile_background_color: "lightyellow"

tile_text_color

Define a cor do texto em todos os blocos de um painel incorporado.

embed_style:
  tile_text_color: "crimson"

elements

Observação: esta seção se refere ao parâmetro elements que faz parte de um dashboard.

elements também pode ser usado como parte de uma linha do painel, descrita na seção elements para linhas nesta página.

O parâmetro elements inicia a seção do LookML em que você define os elementos que vão compor um dashboard. Há muitos parâmetros que podem definir a aparência de um elemento do dashboard. Eles são descritos em mais detalhes na página Parâmetros de elemento do dashboard.

- dashboard: sales_overview
  layout: tile
  tabs:
  - name: Tab 1
    label: Tab 1
  - name: Tab 2
    label: Tab 2
  - name: Tab 3
    label: Tab 3
  elements:
  - name: order_count
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.count]
    tab_name: Tab 1

Dica: pense no número e na complexidade dos elementos que você adiciona a um dashboard do LookML. Mais elementos exigem mais recursos do navegador, o que aumenta o tempo de renderização do painel. Da mesma forma, os elementos que renderizam grandes quantidades de dados podem afetar o desempenho do painel. Se a renderização se tornar um problema, considere reduzir a complexidade das consultas de elementos do dashboard ou criar vários dashboards com menos elementos.

group

Observação: esse recurso está em pré-lançamento.

Organiza os elementos do dashboard em um grupo de blocos em um dashboard do LookML. Para usar grupos de blocos em um dashboard do LookML, o administrador do Looker precisa ativar o recurso em fase de pré-lançamento Grupos de blocos do dashboard, e o dashboard precisa usar o método de layout de dashboard newspaper.

Para criar um grupo de blocos e adicionar elementos a ele no LookML, siga estas etapas:

1. Defina um contêiner de grupo de blocos na seção elements com type: group e especifique name, title, row, col, width e height (e, opcionalmente, tab_name, title_hidden e aria_description). Os elementos de type: group são contêineres visuais e não aceitam parâmetros de consulta, como model, explore ou listen.
2. Em cada elemento do dashboard que você quer colocar dentro do grupo de blocos, adicione o parâmetro group e defina o valor como o name do elemento type: group.

Ao organizar elementos em um grupo de blocos, considere o seguinte:

• Para elementos colocados dentro de um grupo de blocos, os parâmetros row e col definem a posição do elemento em relação ao canto superior esquerdo (row: 0, col: 0) do contêiner do grupo, em vez da tela do painel.
• Em painéis com guias, o tab_name de um elemento filho precisa corresponder ao tab_name do grupo pai.
• O Looker não é compatível com grupos de blocos aninhados (colocar um elemento type: group dentro de outro grupo de blocos).

- dashboard: sales_overview
  layout: newspaper
  elements:
  - name: revenue_metrics_group
    title: "Revenue Metrics"
    type: group
    row: 0
    col: 0
    width: 24
    height: 8
  - name: total_revenue
    title: "Total Revenue"
    type: single_value
    model: ecommerce
    explore: orders
    measures: [orders.total_revenue]
    group: revenue_metrics_group
    row: 0
    col: 0
    width: 8
    height: 6