Em construção: estamos trabalhando para adicionar mais informações a esta página. Enquanto isso, confira a página de documentação Opções de gráfico de registro único para ver informações sobre como criar e editar visualizações de valor único usando o menu de opções de visualização.
Os parâmetros descritos nesta página são usados com elementos de dashboard do LookML de type: looker_single_record em um arquivo dashboard.lkml.
Para saber como criar um gráfico de registro único na interface do Looker, consulte a página de documentação Opções de gráfico de registro único.
Parâmetros básicos
Ao definir um elemento do dashboard do LookML, é preciso especificar valores para pelo menos os parâmetros name e type. Outros parâmetros básicos, como title, height e width, afetam a posição e a aparência de um elemento em um painel.
name
Esta seção se refere ao parâmetro
nameque faz parte de um elemento do dashboard.
nametambém pode ser usado como parte de um filtro de painel, descrito na página de documentação Parâmetros do painel.
Cada declaração name cria um novo elemento do dashboard e atribui um nome a ele.
Os nomes dos elementos precisam ser exclusivos. Às vezes, os nomes são referenciados no parâmetro
elements
quando você usa painéis
layout: grid
ou no parâmetro
group de
elementos filhos ao organizar elementos em um grupo de blocos
(type: group).
- name: orders_by_date
title
Esta seção se refere ao parâmetro
titleque faz parte de um elemento do dashboard.
titletambém pode ser usado como parte de um painel, descrito na página de documentação Parâmetros do painel.
titletambém pode ser usado como parte de um filtro de painel, descrito na página de documentação Parâmetros do painel.
O parâmetro title permite mudar como o nome de um elemento aparece para os usuários. Se não for especificado, o título padrão será o elemento name.
Por exemplo,
- name: sales_overview
title: '1) Sales Overview'
Se você usasse esse formato, em vez de o elemento aparecer como Visão geral de vendas, ele apareceria como 1) Visão geral de vendas.
type
Esta seção se refere ao parâmetro
typeque faz parte de um elemento do dashboard.
typetambém pode ser usado como parte de um filtro de painel, descrito na página de documentação Parâmetros do painel.
typetambém pode ser usado como parte de uma mesclagem, descrita na página de documentação do parâmetrotype(para mesclagens).
typetambé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.
typetambé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 que 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_google_map | looker_geo_coordinates | looker_geo_choropleth |
looker_waterfall | looker_wordcloud | looker_boxplot | button | group
Consulte a página de documentação type (para dashboards do LookML) para uma visão geral dos diferentes tipos de elementos de dashboard do LookML.
height
Esta seção se refere ao parâmetro
heightque faz parte de um elemento do dashboard.
heighttambém pode ser usado como parte de uma linha do painel, descrita na página de documentação Parâmetros do painel.
Para painéis com layouts tile ou static
O parâmetro height define a altura de um elemento, em unidades de tile_size (definido em pixels), para dashboards layout: tile e layout: static.
Por exemplo, o código a seguir especifica tile_size: 100 e height: 4, fazendo com que o elemento orders_by_date tenha 400 pixels de altura.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
height: 4
...
Para painéis com layout newspaper
O parâmetro height define a altura de um elemento, em unidades de linha, para dashboards layout: newspaper.
Um painel com layout de jornal tem como padrão uma altura de elemento de 6 linhas, ou cerca de 300 pixels. A altura mínima é de 1 linha para painéis com um parâmetro preferred viewer definido como dashboards-next. A altura mínima é de duas linhas para dashboards com um parâmetro preferred viewer definido como dashboards.
Por exemplo, o código a seguir define um elemento com 12 linhas de altura, ou o dobro da altura de outros elementos definidos como padrão:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
height: 12
...
width
Esta seção se refere ao parâmetro
widthque faz parte de um elemento do dashboard.
widthtambé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 de um elemento, em unidades de tile_size, para dashboards layout: tile e layout: static.
Por exemplo, o código a seguir especifica tile_size: 100 e width: 4, fazendo com que o elemento orders_by_date tenha 400 pixels de largura.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
width: 4
...
O parâmetro width define a largura de um elemento, em unidades de colunas, para dashboards layout: newspaper.
Um painel com layout de jornal tem uma largura padrão de 24 colunas.
Por exemplo, o código a seguir define o elemento como metade da largura do painel:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
width: 12
...
top
O parâmetro top define a posição de cima para baixo de um elemento, em unidades de tile_size, para painéis layout: static.
Por exemplo, o código a seguir especifica tile_size: 100 e top: 4, posicionando a borda superior do elemento orders_by_date a 400 pixels da parte de cima do painel.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
top: 4
...
left
O parâmetro left define a posição da esquerda para a direita de um elemento, em unidades de tile_size, para painéis layout: static.
Por exemplo, o código a seguir especifica tile_size: 100 e left: 4, posicionando a borda esquerda do elemento orders_by_date a 400 pixels do lado esquerdo do painel.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
left: 4
...
row
Para painéis layout: newspaper,
o parâmetro row define a linha em que a borda superior de um elemento
é colocada. Se o elemento for colocado dentro de um grupo de blocos usando o
parâmetro group, row
vai definir a posição da linha do elemento em relação à parte de cima do contêiner
do grupo (row: 0).
Um painel começa com a linha 0 na parte de cima. Um dashboard com layout de jornal tem como padrão uma altura de elemento de 6 linhas, o que significa que os elementos do dashboard na parte de cima de um dashboard (row: 0) ocupam as linhas de 0 a 5 por padrão.
Cada linha tem 50 pixels de altura, o que significa que a altura padrão do elemento de 6 linhas é de 300 pixels.
Por exemplo, o código a seguir define um elemento na segunda linha de elementos do painel, supondo que os elementos estejam definidos com a altura padrão:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
row: 6
...
col
Para dashboards layout: newspaper, o parâmetro col define a coluna em que a borda esquerda do elemento é colocada. Se o elemento for colocado dentro de um grupo de blocos usando o parâmetro group, col vai definir a posição da coluna do elemento em relação à borda esquerda do contêiner do grupo (col: 0).
Os painéis são divididos em 24 colunas. Um painel começa com a coluna 0 à esquerda. Um dashboard com layout de jornal tem como padrão uma largura de elemento de 8 colunas, o que significa que os elementos do dashboard à esquerda de um dashboard (col: 0) ocupam as colunas de 0 a 7.
Por exemplo, o código a seguir define um elemento para ser colocado na terceira coluna de elementos no painel:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
col: 16
...
refresh
Esta seção se refere ao parâmetro
refreshque faz parte de um elemento do dashboard.
refreshtambém pode ser usado como parte de um painel, descrito na página de documentação Parâmetros do painel.
O parâmetro refresh permite que um elemento seja recarregado automaticamente de forma periódica, recuperando dados atualizados. 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:
- name: orders_by_date
refresh: 2 hours
Tenha cuidado ao definir intervalos de atualização curtos. Se a consulta por trás do elemento exigir muitos recursos, alguns elementos poderão sobrecarregar o banco de dados mais do que o desejado.
note
Você pode adicionar notas descritivas a elementos como este:
- name: element_name
note:
text: 'note text'
state: collapsed | expanded
display: above | below | hover
note tem os subparâmetros text, state e display.
text
O subparâmetro text especifica o texto exibido na observação. O texto pode ser localizado.
state
O subparâmetro state determina se a nota será collapsed ou expanded se for muito grande para caber em uma única linha dentro da largura do elemento. Se você escolher collapsed e a nota for muito longa, ela vai terminar com reticências clicáveis (...) que podem ser usadas para ler a nota completa.
display
O subparâmetro display determina onde a nota é exibida em um elemento. above coloca a nota na parte de cima de um elemento, below coloca na parte de baixo e hover exige que o usuário passe o mouse sobre o elemento para ver a nota.
Parâmetros de consulta
Ao definir um elemento do dashboard do LookML, é preciso especificar valores para pelo menos os parâmetros de consulta model e explore, e pelo menos um campo precisa ser especificado usando o parâmetro dimensions ou measures. Também é possível usar os outros parâmetros de consulta para controlar como os dados são exibidos em um elemento do dashboard.
model
O parâmetro model define o modelo a ser usado para a consulta de elementos. Se não for especificado, o padrão será o modelo em que o painel está.
- name: orders_by_date
model: ecommerce
O parâmetro model aceita constantes do LookML. É possível definir uma constante no arquivo de manifesto do projeto e usar a sintaxe "@{constant_name}" para definir a constante como o valor de model. Com uma constante, você pode definir o nome de um modelo em um só lugar, o que é muito útil se você estiver atualizando o nome de um modelo usado por vários elementos do dashboard.
Para mais informações e um exemplo de uso de constantes com dashboards do LookML, consulte a página de documentação do parâmetro constant.
explore
Esta seção se refere ao parâmetro
exploreque faz parte de um elemento do dashboard.
exploretambém pode ser usado como parte de um modelo, descrito na página de documentação do parâmetroexplore.
exploretambém pode ser usado como parte de um filtro de painel, descrito na página de documentação Parâmetros do painel.
O parâmetro explore define a Análise que será usada para a consulta do elemento.
- name: orders_by_date
explore: order
O parâmetro explore aceita constantes do LookML. É possível definir uma constante no arquivo de manifesto do projeto e usar a sintaxe "@{constant_name}" para definir a constante como o valor de explore. Com uma constante, você pode definir o nome de uma Análise em um só lugar, o que é muito útil se você estiver atualizando o nome de uma Análise usada por vários elementos do dashboard.
Para mais informações e um exemplo de uso de constantes com dashboards do LookML, consulte a página de documentação do parâmetro constant.
dimensions
O parâmetro dimensions define as dimensões que serão usadas na consulta de elementos. Use a sintaxe view_name.dimension_name para especificar a dimensão. Não inclua dimensions se a consulta não tiver nenhum.
## single dimension example
- name: orders_by_date
dimensions: order.order_date
## multiple dimension example
- name: orders_by_date
dimensions: [order.order_date, customer.name]
measures
O parâmetro measures define as medidas que serão usadas na consulta de elemento. Use a sintaxe view_name.measure_name para especificar a métrica. Não inclua measures se a consulta não tiver nenhum.
## single measure example
- name: orders_by_date
measures: order.count
## multiple measure example
- name: orders_by_date
measures: [order.count, order_item.count]
sorts
O parâmetro sorts define o comportamento de classificação para a consulta do elemento. Liste primeiro o campo de classificação principal, seguido pelos campos secundários. Use a sintaxe view_name.field_name para especificar a dimensão ou medida pela qual classificar.
Se você omitir o parâmetro sorts, o elemento vai usar a ordem de classificação padrão do Looker. As classificações crescentes não exigem um sufixo, enquanto as decrescentes exigem o sufixo desc.
O exemplo a seguir define uma única classificação:
- name: orders_by_date
sorts: order.order_date desc
O exemplo a seguir define várias classificações:
- name: orders_by_date
sorts: [order.order_date desc, customer.name]
Se você dinamizar as dimensões, poderá classificar os resultados da consulta especificando o nome da medida, a direção da classificação e o número do índice baseado em 0 da coluna de destino na tabela de dados. Por exemplo, o elemento a seguir classifica pela primeira coluna dinâmica usando o índice 0:
- name: orders_by_category
sorts: [orders.count desc 0]
Para classificar pelo total da linha, especifique o índice da coluna de totais. Por exemplo, o elemento a seguir classifica pelo total da linha usando o índice 2, que representa a coluna de totais de uma consulta com duas colunas dinâmicas:
- name: orders_by_cohort
sorts: [users.count desc 2]
limit
O parâmetro limit define o limite de linhas que deve ser usado para a consulta de elementos. O limite se aplica ao número de linhas antes da aplicação de qualquer tabela dinâmica.
- name: orders_by_date
limit: 100
filters
Esta seção se refere ao parâmetro
filtersque faz parte de um elemento do dashboard.
filterstambém pode ser usado como parte de um painel, descrito na página de documentação Parâmetros do painel.
filterstambém pode ser usado como parte de uma medição, descrita na página de documentação do parâmetrofilters.
O parâmetro filters define os filtros não alteráveis que devem ser usados para a consulta do elemento. Se você quiser filtros que um usuário possa alterar no painel, configure-os usando filters para painéis e aplique-os aos elementos usando listen.
A sintaxe de filters é:
- name: element_name
filters:
orders.created_date: 2020/01/10 for 3 days
orders.status: Shipped
# You can create multiple filter statements
Cada filtro pode aceitar uma expressão de filtro do Looker ou uma constante de valor. Também é possível usar as variáveis líquidas _localization ou _user_attributes na expressão de filtro para valores de filtro flexíveis.
listen
Com os filtros de dashboard, os leitores podem refinar de forma interativa os dados mostrados nos elementos do dashboard. Defina filtros de dashboard com o parâmetro filters para dashboards do LookML. Em seguida, use o parâmetro listen para vincular elementos do dashboard ao filtro.
A sintaxe de listen é a seguinte:
- name: element_name
listen:
filter_name_goes_here: dimension or measure on which to apply
the filter using view_name.field_name syntax
# You can add more than one listen statement
Adicione o parâmetro listen a um elemento e, em seguida, forneça o nome do filtro seguido por dois-pontos e uma referência ao campo ao qual o filtro deve ser aplicado, usando a sintaxe view_name.field_name. Por exemplo, você pode criar um filtro chamado Data que exige que o usuário insira uma data no campo de filtro na UI. Em seguida, você pode aplicar o valor inserido pelo usuário ao elemento orders_by_date desta forma:
- dashboard: sales_overview
...
filters:
- name: date
type: date_filter
elements:
- name: orders_by_date
listen:
date: order.order_date
...
Se o filtro que está sendo ouvido estiver configurado com o parâmetro vis_filter: true, o controle de filtro vai aparecer em uma barra de filtro diretamente na parte de cima do bloco de visualização, em vez de na barra de filtro do painel na parte de cima.
Para mais exemplos de como usar os parâmetros filters e listen para aplicar filtros de dashboard a elementos individuais, consulte Como criar dashboards do LookML.
query_timezone
O parâmetro query_timezone especifica o fuso horário em que a consulta será executada. As opções de fuso horário são mostradas na página de documentação Valores para timezone. Se você quiser que a consulta seja executada usando o fuso horário do espectador, atribua o valor como user_timezone.
- name: orders_by_date
query_timezone: America/Los Angeles
- name: orders_by_customer
query_timezone: user_timezone
merged_queries
O parâmetro merged_queries permite combinar os resultados de várias consultas em um único elemento do dashboard. Defina cada consulta de origem no parâmetro merged_queries do elemento e use o subparâmetro join_fields para especificar como os resultados devem ser mesclados.
O exemplo de código LookML a seguir cria um elemento de resultados combinados de type: looker_grid. Neste exemplo, o parâmetro merged_queries é usado para criar um elemento do dashboard que combina dados de duas consultas separadas em um único gráfico de tabela:
- name: merged_results_element
title: Merged Results Tile
type: looker_grid
merged_queries:
- model: ecommerce
explore: users
type: table
fields: [users.state, users.count, users.city]
sorts: [users.count desc 0]
limit: 5000
column_limit: 50
query_timezone: UTC
listen:
- State: users.state
- model: ecommerce
explore: users
type: table
fields: [users.state, users.city]
sorts: [users.state]
limit: 500
column_limit: 50
query_timezone: UTC
join_fields:
- field_name: users.state
source_field_name: users.state
- field_name: users.city
source_field_name: users.city
listen:
- State: users.state
Neste exemplo, o elemento do dashboard combina dados de duas consultas de origem baseadas na Análise users no modelo ecommerce. A consulta primária inclui os campos users.state, users.count e users.city e classifica os resultados pelo campo users.count. A segunda consulta de origem inclui os campos users.state e users.city e classifica os resultados pelo campo users.state.
O parâmetro join_field mescla as consultas de origem com base nos valores correspondentes nos campos users.state e users.city.
O parâmetro listen aplica um filtro State às duas consultas, o que permite que os leitores do painel refinem os resultados da consulta exibidos no bloco do painel selecionando um estado específico.
Exemplo: mesclar dados da empresa
Suponha que você queira criar uma consulta combinada que reúna informações sobre empresas de duas Análises diferentes: company_info e companies. Você quer mesclar as consultas nos campos ipo.stock_symbol, companies.name e companies.contact_email de cada Análise para criar uma consulta que retorne resultados para o nome da empresa, o e-mail de contato da empresa, o ano do IPO, o símbolo da ação, o número de funcionários e a contagem de vagas. É possível definir o elemento de consulta mesclada no LookML da seguinte maneira:
- name: merged_results_element
title: Merged Results Tile
merged_queries:
- model: market_research
explore: company_info
fields: [companies.name, companies.contact_email, ipo.public_year, ipo.stock_symbol]
filters:
companies.contact_email: "-NULL"
ipo.valuation_amount: NOT NULL
sorts: [ipo.public_year desc]
- model: company_data
explore: companies
fields: [companies.name, ipo.stock_symbol, companies.contact_email,
companies.number_of_employees, jobs.job_count]
filters:
companies.number_of_employees: NOT NULL
ipo.stock_symbol: "-NULL"
companies.contact_email: "-NULL"
sorts: [jobs.job_count desc]
join_fields:
- field_name: ipo.stock_symbol
source_field_name: ipo.stock_symbol
- field_name: companies.name
source_field_name: companies.name
- field_name: companies.contact_email
source_field_name: companies.contact_email
Como aplicar filtros a elementos de consulta combinados
O exemplo anterior de um elemento de consulta combinada demonstra como aplicar filtros codificados diretamente em cada consulta de origem usando o parâmetro filters. Por exemplo, os filtros companies.contact_email: "-NULL" e ipo.valuation_amount: NOT NULL na consulta primária restringem os resultados a empresas que têm e-mails de contato e avaliações válidos. Esses filtros no nível da consulta pré-filtram os dados antes de mesclar as consultas e não podem ser alterados pelo usuário.
Também é possível aplicar filtros de painel a elementos de consulta mesclados usando o parâmetro listen na definição de cada consulta de origem. Por exemplo, suponha que você tenha um filtro de dashboard chamado Industry que foi definido no nível do dashboard usando o parâmetro filters para dashboards do LookML:
filters:
- name: Industry
title: Industry
type: field_filter
ui_config:
type: dropdown_menu
display: inline
model: market_research
explore: company_info
field: companies.industry
Para aplicar o filtro Industry ao campo companies.industry nas duas consultas de origem, adicione o parâmetro listen a cada uma das definições de consulta de origem da consulta mesclada da seguinte maneira:
listen:
Industry: companies.industry
Por exemplo, o exemplo de código a seguir adiciona o filtro Industry às duas consultas de origem no elemento de resultados combinados do exemplo anterior.
- name: merged_results_element
title: Merged Results Tile
merged_queries:
- model: market_research
explore: company_info
fields: [companies.name, companies.contact_email, ipo.public_year, ipo.stock_symbol]
filters:
companies.contact_email: "-NULL"
ipo.valuation_amount: NOT NULL
sorts: [ipo.public_year desc]
listen:
Industry: companies.industry
- model: company_data
explore: companies
fields: [companies.name, ipo.stock_symbol, companies.contact_email,
companies.number_of_employees, jobs.job_count]
filters:
companies.number_of_employees: NOT NULL
ipo.stock_symbol: "-NULL"
companies.contact_email: "-NULL"
sorts: [jobs.job_count desc]
join_fields:
- field_name: ipo.stock_symbol
source_field_name: ipo.stock_symbol
- field_name: companies.name
source_field_name: companies.name
- field_name: companies.contact_email
source_field_name: companies.contact_email
listen:
Industry: companies.industry
Com essa adição, quando um usuário interage com o filtro do dashboard Industry, a consulta de origem correspondente no elemento de consulta mesclada é filtrada de acordo.
hidden_fields
O parâmetro hidden_fields indica quais campos, se houver, são usados na consulta, mas ocultos no gráfico. Todos os campos ocultos vão aparecer na seção da tabela de dados de uma Análise.
hidden_fields: [inventory_items.count, distribution_centers.id]
Parâmetros de registro único
Nesta seção, descrevemos os equivalentes em LookML das opções no menu Editar para gráficos de registro único.
show_view_names
O parâmetro show_view_names determina se os nomes das visualizações são mostrados nos rótulos do gráfico, como nomes de eixos e de colunas.
show_view_names: true | false
## default value: true