É possível criar painéis de duas maneiras. Os painéis definidos pelo usuário são criados por meio da IU do Looker e são descritos na página Como criar painéis definidos pelo usuário. Os painéis também podem ser criados com o LookML e as configurações gerais são modificadas conforme discutido nesta página.
Um painel tem várias configurações que afetam todo o painel, que são descritas aqui. Ele também contém um grupo de visualizações de dados, chamadas de elementos. O LookML desses elementos é descrito nas páginas de documentação de cada tipo de elemento individual.
Exemplo de uso
- dashboard: dashboard_name
preferred_viewer: dashboards | dashboards-next
title: "desired dashboard title"
description: "desired dashboard description"
extends: name_of_dashboard_being_extended
extension: required
layout: tile | static | grid | newspaper
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: "desired filter title"
type: field_filter | number_filter | date_filter | string_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
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
Definições de parâmetro
Os parâmetros com o rótulo NÃO SUPORTADO POR LEGADO só entram em vigor quando um painel é renderizado usando a experiência padrão, seja preferred_viewer: dashboards-next
ou convertendo um painel LookML legado em um painel definido pelo usuário e, em seguida, atualizando o painel definido pelo usuário.
Nome do parâmetro | Descrição |
---|---|
dashboard |
Crie um painel. |
preferred_viewer |
Escolha renderizar um painel como um painel ou um painel legado. |
title (para painel) |
Altere a forma como o nome de um painel é exibido para os usuários. |
description (para painel) |
Adicione uma descrição de marcador de posição a ser usada se o painel for convertido em um painel definido pelo usuário. |
extends |
Use o painel LookML como base. |
extension |
Exigir que o painel seja estendido por outro. |
layout |
Defina a forma como o painel vai posicionar os elementos. |
rows |
Inicie uma seção de LookML para definir os elementos que precisam ser inseridos em cada linha de um painel layout: grid . |
elements (para linhas) |
Defina os elementos que precisam ficar em uma linha do painel layout: grid . |
height (para linhas) |
Defina a altura de uma linha para um painel layout: grid . |
tile_size |
Definir o tamanho de um Bloco para um painel de controle layout: tile . |
width (para painel) |
Definir a largura de um painel para layout: static . |
refresh (para painel) |
Defina o intervalo de atualização automática dos elementos do painel. |
auto_run |
Determine se os painéis são executados automaticamente quando abertos ou atualizados. |
Parâmetros de filtro | |
crossfilter_enabled |
INCOMPATÍVEL POR LEGADO Ativar ou desativar o filtro cruzado para um painel que também usa preferred_viewer: dashboards-next . |
filters_bar_collapsed |
ADDED 21.16
UNSUPPORTED POR LEGACY Defina a barra de filtro do painel como padrão recolhido ou expandido para um painel que também usa preferred_viewer: dashboards-next . |
filters_location_top |
ADDED 22.8
INCOMPATÍVEL POR LEGADO Defina o local da barra de filtros do painel como superior ou direito em um painel que também usa preferred_viewer: dashboards-next . |
filters (para painel) |
Iniciar uma seção de LookML para definir filtros de painel. |
name (para filtros) |
Criar um filtro. |
title (para filtros) |
Altere a forma como o nome de um filtro aparece para os usuários. |
type (para filtros) |
Determine o tipo de filtro a ser usado. |
default_value |
Defina um valor padrão para um filtro, se quiser. |
allow_multiple_values |
Limite 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 |
INCOMPATÍVEL POR LEGADO Configure os controles de filtro que estão disponíveis quando os usuários veem um painel do LookML que é renderizado na nova experiência do painel, com preferred_viewer definido como dashboards-next (não um painel legado, com preferred_viewer definido como dashboards ). Tem subparâmetros type , display e options . |
model (para filtros) |
Especifique o modelo que contém o campo subjacente de um filtro type: field_filter . |
explore (para filtros) |
Especifique o Explore que contém o campo subjacente de um filtro type: field_filter . |
field |
Especifique o campo subjacente de um filtro de type: field_filter . |
listens_to_filters |
Limite as sugestões para os filtros do painel field_filter com base no que o usuário digita para outros filtros do painel de type: field_filter .
|
Parâmetros do painel incorporado | |
embed_style |
Inicie uma seção do LookML para definir as personalizações do painel incorporado. |
background_color |
Defina a cor do plano de fundo de um painel incorporado. |
show_title |
Especifique se o título do painel está visível em um painel incorporado. |
title_color |
Defina a cor do título de um painel incorporado. |
show_filters_bar |
Especifique se a barra de filtros fica visível em um painel incorporado. |
tile_background_color |
Define a cor do plano de fundo do bloco de um painel incorporado. |
tile_text_color |
Define a cor do texto do bloco de um painel incorporado. |
Parâmetros do elemento | |
elements (para painel) |
Inicie uma seção do LookML para definir os elementos do painel. |
dashboard
O parâmetro dashboard
declara um novo painel e especifica um nome para ele. O número máximo de caracteres é 255. Os caracteres permitidos são letras (A-Z), números (0-9), traços (-) e sublinhados (_). Geralmente, é recomendável colocar cada painel LookML em um arquivo LookML, mas é possível declarar vários painéis em um único arquivo.
- dashboard: sales_overview
Para exibir qualquer informação, um painel precisa adicionar pelo menos um elemento usando o parâmetro elements
.
preferred_viewer
O parâmetro preferred_viewer
permite escolher o formato para visualizar e fazer o download de um painel. Ele aceita os seguintes valores:
dashboards
: o renderizador baseado em AngularJS para painéis legados.dashboards-next
: o renderizador baseado em React para a experiência padrão do painel.
Os painéis LookML com preferred_viewer: dashboards
que são convertidos em painéis definidos pelo usuário podem ser renderizados usando a nova experiência do painel fazendo upgrade do painel definido pelo usuário.
title
(para o painel)
Esta seção se refere ao parâmetro
title
que faz parte de um painel.O
title
também pode ser usado como parte de um filtro do painel, descrito na seçãotitle
(para filtros) desta página.
title
também pode ser usado como parte de qualquer elemento do painel. Um exemplo representativo de uso é mostrado na página de elementos do gráfico de colunas.
Com o parâmetro title
, é possível mudar a aparência do nome de um painel para os usuários em pastas e na parte superior do painel. Se não for especificado, o título usará como padrão o nome do painel. O texto do título pode ser localizado.
Veja este 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)
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 exploração, conforme descrito na página de documentação do parâmetrodescription
(para explorações).
description
também pode ser usado como parte de um campo, conforme descrito na página de documentação de parâmetrosdescription
(para campos).
O parâmetro description
permite adicionar uma descrição a um painel do LookML.
A descrição é exibida abaixo do título do painel nas listas de painéis quando visualizadas em uma pasta. Se uma descrição não for especificada, a lista exibirá apenas o título do painel.
O texto da descrição pode ser localizado.
extends
Conforme descrito na página de documentação Reutilização de códigos com extensões, o parâmetro extends
permite basear um painel LookML em outro painel LookML, possivelmente adicionando ou modificando algumas configurações. O parâmetro extends
aceita o nome de outro painel do LookML.
Ao estender um objeto, lembre-se de que 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 seu projeto. Consulte a página de documentação Como localizar seu modelo LookML para mais informações.
extension
Conforme descrito nesta página, o parâmetro extension
indica que o painel precisa ser estendido por outro painel. Este painel nunca fica visível para outros usuários, mas pode ser usado como modelo para criar outros painéis visíveis para outros usuários. O parâmetro extension
aceita apenas o valor required
. Se o parâmetro extension
não estiver 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 usará ao posicionar elementos do painel. Ele aceita os seguintes valores:
newspaper
: os elementos do painel aparecem 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 podem ser configurados ao longo desta grade, especificados pelos parâmetros de elementowidth
,height
,row
ecol
. Essa opção de layout é usada quando um painel definido pelo usuário é convertido em um painel do LookML, bem como é o layout padrão quando um novo painel do LookML é criado por meio do ambiente de desenvolvimento integrado do Looker. Além disso, quandopreferred_viewer
é definido comodashboards-next
,newspaper
é o único layout compatível com a conversão de um painel LookML em um definido pelo usuário.grid
: os elementos do painel aparecem com larguras dinâmicas, com base em um conjunto de linhas que você define com o parâmetrorows
e os subparâmetroselements
eheight
. Quandopreferred_viewer
é definido comodashboards-next
, ogrid
não oferece suporte à conversão de um painel do LookML em um definido pelo usuário.static
: os elementos do painel aparecem na ordem em que são listados no arquivo LookML. Cada elemento do painel precisa ser posicionado manualmente usando os parâmetrostop
eleft
. 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 comotop
eleft
funcionam, consulte a página de documentação Parâmetros do gráfico de colunas para painéis LookML. Quandopreferred_viewer
é definido comodashboards-next
, ostatic
não oferece suporte à conversão de um painel do LookML em um definido pelo usuário.tile
: os elementos do painel aparecem na ordem em que são listados no arquivo LookML. A largura do painel é dinâmica e se baseia na largura do navegador. Os elementos do painel se posicionam dinamicamente no navegador para preencher o espaço disponível. Quandopreferred_viewer
é definido comodashboards-next
, otile
não oferece suporte à conversão de um painel do LookML em um definido pelo usuário.
rows
Para painéis layout: grid
, o parâmetro rows
inicia a seção do LookML, em que você define quais elementos precisam ser inseridos em cada linha, bem como a altura de cada linha. Em cada linha, cada elemento tem a mesma largura. Se você não listar um elemento nessa seção, ele não 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 painel, separados por vírgulas. Cada declaração elements
cria uma nova linha no painel. Todos os elementos colocados em uma linha terão a mesma largura. Dessa forma, se você colocar dois elementos em sequência, cada um ocupará 50% do espaço disponível. Se você colocar quatro elementos em uma linha, cada um deles ocupará 25% do espaço disponível, e assim por diante.
height
O parâmetro height
define a altura de uma linha em pixels. O valor padrão é 300.
tile_size
Nos 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 painel com height: 5
e width: 3
vai 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 do gráfico de colunas para painéis LookML.
width
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 painel. Um exemplo representativo de uso é mostrado na página de documentação dos elementos de gráficos 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 restringirá o painel para 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á 1.200.
- dashboard: sales_overview
layout: static
width: 800
refresh
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 painel. Um exemplo representativo de uso é mostrado na página de documentação dos elementos de gráfico de colunas.
O parâmetro refresh
permite que um painel seja recarregado automaticamente periodicamente, recuperando novos dados. Isso geralmente é útil em configurações em que um painel é exibido constantemente, como em uma TV do 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 curtos de atualização. Como os painéis podem conter muitas consultas, algumas delas usam muitos recursos, por isso, alguns painéis podem sobrecarregar seu banco de dados.
auto_run
O parâmetro auto_run
determina se um painel será executado ou não quando for aberto ou atualizado. O valor padrão é true. Quando ele for definido como falso, os usuários precisarão pressionar o botão Executar para carregar o painel. Por exemplo, um painel como este será executado automaticamente quando aberto:
- dashboard: sales_overview
auto_run: true
Seja qual for a configuração de auto_run
, os usuários sempre precisarão clicar em um botão Run depois de mudar os valores do filtro. Isso ajuda a evitar recargas indesejadas quando um usuário faz uma pausa durante uma mudança de filtro ou quer alterar vários filtros ao mesmo tempo.
crossfilter_enabled
Este parâmetro se aplica somente aos painéis do LookML que são renderizados usando a experiência padrão do Looker, definindo o parâmetro
preferred_viewer
comodashboards-next
.
Com o parâmetro crossfilter_enabled
, é possível ativar ou desativar filtros cruzados em um painel que também usa o preferred_viewer: dashboards-next
. Quando esse parâmetro é definido como true
, os visualizadores do painel podem criar filtros cruzados clicando em determinados pontos de dados.
- dashboard: sales_data
preferred_viewer: dashboards-next
crossfilter_enabled: true
crossfilter_enabled
não entrará em vigor nos painéis do LookML usando preferred_viewer: dashboards
. No entanto, se um painel LookML que usa crossfilter_enabled
e preferred_viewer: dashboards
for convertido em um painel definido pelo usuário e atualizado, crossfilter_enabled
terá efeito no painel atualizado.
filters_bar_collapsed
Este parâmetro se aplica somente aos painéis do LookML que são renderizados usando a experiência padrão do Looker, definindo o parâmetro
preferred_viewer
comodashboards-next
.
O parâmetro filters_bar_collapsed
permite definir a barra de filtro do painel como padrão recolhido ou expandido para um painel que também usa preferred_viewer: dashboards-next
. Quando esse parâmetro é definido como true
, a barra de filtro é recolhida padrão. Os visualizadores do painel podem expandir a barra de filtros clicando no ícone de filtros. O padrão para essa configuração é false
.
- dashboard: sales_data
preferred_viewer: dashboards-next
filters_bar_collapsed: true
filters_bar_collapsed
não entrará em vigor nos painéis do LookML usando preferred_viewer: dashboards
. No entanto, se um painel LookML que usa filters_bar_collapsed
e preferred_viewer: dashboards
for convertido em um painel definido pelo usuário e atualizado, filters_bar_collapsed
terá efeito no painel atualizado.
filters_location_top
Este parâmetro se aplica somente aos painéis do LookML que são renderizados usando a experiência padrão do Looker, definindo o parâmetro
preferred_viewer
comodashboards-next
.
Com o parâmetro filters_location_top
, você pode posicionar a barra de filtro no painel superior ou à direita em um painel que também usa o preferred_viewer: dashboards-next
. Quando esse parâmetro é definido como true
, a barra de filtro aparece na parte de cima do painel. Quando definida como false
, ela aparece à direita do painel. O padrão para essa configuração é true
.
- dashboard: sales_data
preferred_viewer: dashboards-next
filters_location_top: false
filters_location_top
não entrará em vigor nos painéis do LookML usando preferred_viewer: dashboards
. No entanto, se um painel LookML que usa filters_location_top
e preferred_viewer: dashboards
for convertido em um painel definido pelo usuário e atualizado, filters_location_top
terá efeito no painel atualizado.
filters
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 painel. Um exemplo representativo de uso é mostrado na página de documentação dos elementos de gráfico de colunas.O
filters
também pode ser usado como parte de uma medida, descrita na página de documentação do parâmetrofilters
.
O parâmetro filters
inicia a seção do LookML em que você define os filtros do painel. Os filtros aparecem na parte de cima do painel e permitem que os usuários alterem os dados por trás dos elementos.
Para que um filtro afete um elemento, ele precisa ser configurado para "detectar" esse filtro usando o parâmetro listen
. Esse parâmetro se aplica a todos os tipos de elementos, exceto type: text
, e 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 do gráfico de colunas para painéis LookML.
Quando os filtros são aplicados a um elemento dessa maneira, é importante que o filtro type
corresponda à dimensão ou ao tipo de medida que está ouvindo o filtro. Para ver mais detalhes, consulte Como criar painéis do LookML. Os filtros têm o seguinte formato:
filters:
- name: filter_name
title: "desired filter title"
type: field_filter | number_filter | date_filter | string_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
listens_to_filters:
- filter_name
field: view_name.field_name
name
Esta seção se refere ao parâmetro
name
que faz parte de um filtro do painel.
name
também pode ser usado como parte de um elemento do painel. Um exemplo representativo de uso é mostrado na página de documentação dos elementos de gráfico de colunas.
Cada declaração name
cria um novo filtro de painel e atribui um nome a ele. O nome vai ser referenciado no parâmetro listen
dos elementos que vão ser afetados pelo filtro. O parâmetro listen
se aplica a todos os tipos de elementos, exceto type: text
, e 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 do gráfico de colunas para painéis LookML.
filters:
- name: order_date
title
(para filtros)
Esta seção se refere ao parâmetro
title
que faz parte de um filtro do painel.
title
também pode ser usado como parte de um painel, conforme descrito na seçãotitle
(para painel) desta página.
title
também pode ser usado como parte de um elemento do painel. Um exemplo representativo de uso é mostrado na página de documentação Parâmetros do gráfico de colunas para painéis LookML.
O parâmetro title
permite mudar a forma como o nome de um filtro aparecerá para os usuários na parte superior de um painel. Se não for especificado, o título padrão será o nome do filtro.
Veja este exemplo:
filters:
- name: order_date
title: "Order Date(s)"
Se você fizer isso, em vez do filtro aparecer como Data do pedido, ele aparecerá como Datas dos pedidos.
type
Esta seção se refere ao parâmetro
type
que faz parte de um filtro do painel.
type
também pode ser usado como parte de um elemento do painel, descrito na página de documentação de parâmetrostype
(para painéis LookML).O
type
também pode ser usado como parte de uma mesclagem, descrita na página de documentação do parâmetro de parâmetrotype
.
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
especifica o tipo de entrada que será colocada no filtro. Embora qualquer tipo de entrada (como uma data) possa ser gravada no filtro type: string_filter
, ser mais específico fornece um widget de filtro mais personalizado ao usuário. Os quatro tipos de filtro são:
field_filter
: geralmente é a escolha padrão, quando é possível especificar uma dimensão ou medida. O uso detype: field_filter
e a associação do filtro com um campo dotype:string
faz com que o filtro sugira possíveis valores de filtro.number_filter
: permite que o usuário insira um número/valor inteiro ou uma expressão.date_filter
: permite que o usuário insira um valor ou expressão de data.string_filter
: permite que o usuário insira texto em formato livre.
field_filter
Sugere opções, muda a apresentação para usuários com base no campo subjacente especificado.
Esse é o tipo de filtro principal em situações em que você quer fazer sugestões para os 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 proveniente de uma tabela derivada, se sql_always_where
for usado em Explorar ou se o campo for uma medida.
filters:
- name: order_date
type: field_filter
explore: orders
field: orders.order_date # must be of the form view_name.dimension_name
number_filter
Não faz sugestões e permite ao usuário inserir um valor ou uma expressão de número inteiro/número.
filters:
- name: order_value
type: number_filter
date_filter
Não faz sugestões, permite que o usuário insira um valor de data ou expressão.
filters:
- name: order_date
type: date_filter
string_filter
Não faz sugestões, permite que o usuário insira texto em formato livre.
filters:
- name: customer_name
type: string_filter
default_value
O parâmetro default_value
permite especificar um valor padrão a ser usado em 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: string_filter
default_value: "John Doe"
É possível usar expressões de filtro para criar valores padrão. A página de expressões de filtro do Looker descreve isso com 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 para o subparâmetro type
do ui_config
e os tipos de dados compatíveis com 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 ele é definido como true
(padrão), os usuários podem selecionar vários valores para o filtro. Quando ele é definido como false
, os usuários só podem selecionar um valor de filtro.
Para painéis LookML que usam a experiência legada, com um preferred_viewer
definido como dashboards
, o allow_multiple_values
pode ser aplicado a filtros de qualquer type
.
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 painel. Por padrão, os filtros não exigem valores. Se um filtro não precisar de um valor e for deixado em branco, os dados simplesmente não serão restritos pelo campo de filtro. Se um filtro que exige um valor e for deixado em branco, o painel não será executado.
filters:
- name: State
title: State
type: field_filter
required: true
ui_config
Este parâmetro se aplica somente aos painéis do LookML que são renderizados usando a experiência padrão do Looker, definindo o parâmetro
preferred_viewer
comodashboards-next
.
O subparâmetro ui_config
do filters
permite definir configurações de filtro que se aplicam quando um painel do LookML é visualizado como um painel (não quando um painel do LookML é visualizado como um painel legado), definindo o parâmetro preferred_viewer
como dashboards-next
. Essas configurações incluem os tipos de controles de filtros usados, a posição deles e os possíveis valores de filtro.
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
A configuração especificada com o subparâmetro ui_config
não vai entrar em vigor nos painéis do LookML usando preferred_viewer: dashboards
. No entanto, se um painel LookML que usa ui_config
e preferred_viewer: dashboards
for convertido em um painel definido pelo usuário e atualizado, ui_config
terá efeito no painel atualizado.
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 IU.
type
O subparâmetro type
de ui_config
permite especificar os tipos de controles de filtros mostrados quando os usuários veem um painel do LookML como um painel, e não como um painel legado.
Dependendo do valor inserido em type
, os controles de filtro podem ser de seleção única ou múltipla.
Os valores compatíveis com
type
dependem dos dados do LookMLtype
atribuídos ao campo que você está filtrando.
N = funciona com o tipo de dados [`number`](/looker/docs/2216/reference/param-dimension-filter-parameter-types#number) e os valores numéricos
T
DU = funciona com o tipo de dados [`duration`](/looker/docs/2216/reference/param-dimension-filter-parameter-types#duration)
DT = funciona com: [data, tipo, número, tipo, tipo
Valor | Descrição | Tipo 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 . | PN T ZC YN DI DU |
checkboxes | O filtro mostra caixas de seleção, com uma caixa para cada valor especificado com o parâmetro options . | PN T ZC YN DI DU |
tag_list | O filtro mostra um menu suspenso com cada valor possível especificado usando o parâmetro options . | P N T ZC DI DU |
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 do 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 . | N DI DU |
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 . | PN T ZC YN DI DU P |
radio_buttons | O filtro exibe 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 . | PN T ZC YN DI DU P |
dropdown_menu | O filtro mostra um menu suspenso que lista cada valor possível especificado com o parâmetro options . No menu suspenso, os usuários também têm a opção de selecionar Qualquer valor. | PN T ZC YN DI DU P |
slider | Em 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 . | N DI DU |
Datas e horas | ||
day_picker | O filtro permite que os usuários escolham uma data específica. | DT* O controle de um único dia pode ser usado com a maioria dos períodos e tipos baseados em tempo, mas os espectadores 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 de término para filtrar por um período. | DD*: o controle de período pode ser usado com a maioria dos períodos e tipos, mas os espectadores só podem selecionar períodos com esse tipo de controle. |
date_time_range_input | Com o filtro, o usuário pode filtrar em um intervalo de datas e horas. | DD*: é possível usar o controle de período e data com a maioria dos tipos baseados em tempo, e os espectadores 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 intervalo personalizado de datas ou escolha entre predefinições de período, como Hoje, Últimos 7 dias, Últimos 90 dias e assim por diante. | DT*: o controle de período pode ser usado com a maioria dos períodos e tipos baseados em tempo, mas os espectadores não podem selecionar opções de tempo com esse tipo de controle. |
Outro | ||
advanced | O filtro tem opções para aplicar um ou mais filtros de filtros ou correspondências avançadas. Consulte a seção Como usar controles avançados nesta página para saber mais sobre controles avançados. | S N T ZC YN DT DI DU L P |
*Observação sobre dados de data e hora: Alguns períodos e tipos com base no 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, compatível com os valores aceitos pelo tipo yesno . O período hour_of_day , que é interpretado como um tipo de dadosnumber , é compatível com os valores aceitos pelo tipo number . |
display
É possível usar o subparâmetro display
de ui_config
para definir a posição de um filtro do painel. É possível posicionar um filtro atribuindo um dos seguintes valores a display
:
inline
: o filtro é exibido diretamente na barra superior do painel.popover
: um valor de resumo é exibido na barra superior do painel. Clique no valor para ver o filtro completo.overflow
: um botão Mais é exibido na barra superior do painel com um indicador numérico de quantos filtros de excesso existem. Os usuários podem clicar no botão para ver os filtros flutuantes e seus valores.
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ê conceder a um filtro um valor display
que não seja válido para type
, ele será exibido como inline
ou popover
, o que for válido. Para saber mais, consulte a página Adicionar e editar filtros de painel definidos pelo usuário.
Para mais informações sobre como posicionar filtros de painel usando a IU, 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 do filtro do painel quando visualizar um painel LookML como um painel (não um legado). Se você não especificar valores para options
, o Looker 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 forma:
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
, você pode usar 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 os filtros do painel de type: field_filter
, você precisa definir um modelo que vai receber sugestões. O parâmetro model
especifica qual modelo contém o campo que você quer usar.
filters:
- name: State
title: State
type: field_filter
default_value: California
model: thelookstore
explore: users
field: users.state
explore
Esta seção se refere ao parâmetro
explore
que faz parte de um filtro do painel.O
explore
também pode ser usado como parte de um modelo, descrito na página de documentação do parâmetroexplore
.
explore
também pode ser usado como parte de um elemento do painel. Um exemplo representativo de uso é mostrado na página de documentação dos elementos de gráfico de colunas.
Para filtros do painel de type: field_filter
, é necessário definir um campo de onde o filtro vai extrair sugestões. O parâmetro explore
especifica qual exploração contém o campo que você quer usar.
filters:
- name: order_date
type: field_filter
explore: orders
field: orders.order_date
field
Para filtros do painel de type: field_filter
, é necessário 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 de 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 os filtros do painel type: field_filter
, é possível restringir as sugestões com base no que o usuário digita para 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, e esses valores serão sugeridos para State
. Consulte a página Adicionar e editar filtros de painel definidos pelo usuário para mais informações.
filters:
- name: State
title: State
type: field_filter
model: thelookstore
explore: users
listens_to_filters:
- Order ID
field: users.state
embed_style
O parâmetro embed_style
inicia a seção do LookML, em que você personaliza a aparência de um painel incorporado. embed_style
e os parâmetros associados a ele são compatíveis apenas com painéis incorporados e são ignorados se o painel não estiver incorporado.
Depois de fazer mudanças no embed_style
, é preciso implantar o LookML na produção para ver as configurações do embed_style
refletidas no painel incorporado do LookML.
Para os seguintes atributos incorporados do painel que especificam uma cor, o valor da cor pode ser hexadecimal, como #2ca6cd
, ou uma string de cor CSS, como mediumblue
.
As personalizações do painel incorporado 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 ficam visíveis aos usuários.
Esse parâmetro afeta apenas a aparência estética do painel, não a capacidade de um usuário acessar os dados. Ocultar a barra de filtros NÃO impede que os usuários alterem os filtros de outras formas. Para informações sobre como configurar políticas de controle de acesso seguro a dados, consulte a página 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 em um painel incorporado.
embed_style:
tile_text_color: "crimson"
elements
Esta seção se refere ao parâmetro
elements
que faz parte de umdashboard
.
elements
também pode ser usado como parte de uma linha do painel, descrita na seçãoelements
para linhas nesta página.
O parâmetro elements
inicia a seção do LookML, em que você define os elementos que compõem um painel. Há muitos parâmetros que podem definir a aparência de um elemento do painel. Eles são descritos em mais detalhes na página Parâmetros de elementos do painel.
- dashboard: sales_overview
layout: tile
elements:
- name: order_count
type: single_value
model: ecommerce
explore: orders
measures: [orders.count]
Pense no número e na complexidade dos elementos adicionados a um painel do LookML. Mais elementos precisam de mais recursos do navegador, o que aumenta o tempo de renderização do painel. Da mesma forma, elementos que renderizam grandes quantidades de dados podem afetar o desempenho do painel. Se a renderização se tornar um problema, simplifique os elementos ou crie vários painéis com menos elementos.