Em construção:estamos trabalhando para adicionar mais conteúdo a esta página. Enquanto isso, consulte a página de documentação Opções de gráfico de registro único para conferir 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 para uso com elementos de dashboard do LookML de type: looker_single_record em um dashboard.lkml arquivo.
Para informações sobre 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, é necessário 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 dashboard.
name
Esta seção se refere ao
nameparâmetro que faz parte de um elemento do dashboard.
nametambém pode ser usado como parte de um filtro de dashboard, descrito na página de documentação Parâmetros de dashboard.
Cada declaração name cria um novo elemento do dashboard e atribui um nome a ele. Os nomes dos elementos precisam ser exclusivos. Os nomes às vezes são referenciados no elements parâmetro quando você usa layout: grid dashboards.
- name: orders_by_date
title
Esta seção se refere ao
titleparâmetro que faz parte de um elemento do dashboard.
titletambém pode ser usado como parte de um dashboard, descrito na página de documentação Parâmetros de dashboard.
titletambém pode ser usado como parte de um filtro de dashboard, descrito na página de documentação Parâmetros de dashboard.
O parâmetro title permite mudar a forma como o nome de um elemento aparece para os usuários. Se não for especificado, o título será o name do elemento por padrão.
Por exemplo,
- name: sales_overview
title: '1) Sales Overview'
Se você usasse esse formato, em vez de o elemento aparecer como Visão geral das vendas, ele apareceria como 1) Visão geral das vendas.
type
Esta seção se refere ao
typeparâmetro que faz parte de um elemento do dashboard.
typetambém pode ser usado como parte de um filtro de dashboard, descrito na página de documentação Parâmetros de dashboard.
typetambém pode ser usado como parte de uma mesclagem, descrito na página de documentação do parâmetrotype(para mesclagens).
typetambém pode ser usado como parte de uma dimensão, descrito na página de documentação Tipos de dimensões, filtros e parâmetros.
typetambém pode ser usado como parte de uma medida, descrito na página de documentação Tipos de medidas.
O parâmetro type determina o tipo de visualização a ser usado no elemento.
- name: element_name
type: text | looker_grid | table | single_value | looker_single_record |
looker_column | looker_bar | looker_scatter | looker_line | looker_area |
looker_pie | looker_donut_multiples | looker_funnel | looker_timeline |
looker_map | looker_google_map | looker_geo_coordinates | looker_geo_choropleth | looker_waterfall | looker_wordcloud | looker_boxplot
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
heightparâmetro que faz parte de um elemento do dashboard.
heighttambém pode ser usado como parte de uma linha de dashboard, descrito na página de documentação Parâmetros de dashboard.
Para dashboards 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, tornando o elemento orders_by_date com 400 pixels de altura.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
height: 4
...
Para dashboards com layout newspaper
O parâmetro height define a altura de um elemento, em unidades de linha, para layout: newspaper dashboards.
Um dashboard com layout de jornal tem uma altura de elemento padrão de 6 linhas ou cerca de 300 pixels. A altura mínima é de 1 linha para dashboards com um preferred viewer parâmetro definido como dashboards-next. A altura mínima é de 2 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 duas vezes mais alto que 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
widthparâmetro que faz parte de um elemento do dashboard.
widthtambém pode ser usado como parte de um dashboard, descrito na página de documentação Parâmetros de dashboard.
O parâmetro width define a largura de um elemento, em unidades de tile_size, para layout: tile e layout: static dashboards.
Por exemplo, o código a seguir especifica tile_size: 100 e width: 4, tornando o elemento orders_by_date com 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 layout: newspaper dashboards.
Um dashboard 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 dashboard:
- 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 layout: static dashboards.
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 dashboard.
- 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 dashboards 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 dashboard.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
left: 4
...
row
Para layout: newspaper dashboards, o row parâmetro define a linha em que a borda superior de um elemento é colocada.
Um dashboard começa com a linha 0 na parte de cima. Um dashboard com layout de jornal tem uma altura de elemento padrão de 6 linhas, o que significa que os elementos do dashboard na parte de cima (row: 0) seriam definidos como padrão para ocupar as linhas de 0 a 5.
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 a ser definido na segunda linha de elementos no dashboard, supondo que os elementos estejam definidos na altura padrão:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
row: 6
...
col
Para layout: newspaper dashboards, o col parâmetro define a coluna em que a borda esquerda do elemento é colocada.
Os dashboards são divididos em 24 colunas. Um dashboard começa com a coluna 0 à esquerda. Um dashboard com layout de jornal tem uma largura de elemento padrão de 8 colunas, o que significa que os elementos do dashboard à esquerda (col: 0) seriam definidos como padrão para ocupar as colunas de 0 a 7.
Por exemplo, o código a seguir define um elemento a ser definido na terceira coluna de elementos no dashboard:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
col: 16
...
refresh
Esta seção se refere ao
refreshparâmetro que faz parte de um elemento do dashboard.
refreshtambém pode ser usado como parte de um dashboard, descrito na página de documentação Parâmetros de dashboard.
O parâmetro refresh permite que um elemento seja recarregado automaticamente em uma base periódica, recuperando dados atualizados. Isso geralmente é útil em configurações em que um dashboard é exibido constantemente, como em uma TV de escritório. Observação: o dashboard 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 dashboard.
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 for intensa em recursos, alguns elementos poderão sobrecarregar seu banco de dados mais do que o desejado.
note
É possível 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 nota. 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 em uma reticências clicável (...) que pode ser usada para ler a nota completa.
display
O subparâmetro display determina onde a observação é exibida em um elemento. above coloca a observação na parte de cima de um elemento, below a coloca na parte de baixo e hover exige que o usuário passe o cursor do mouse sobre o elemento para ver a observação.
Parâmetros de consulta
Ao definir um elemento de dashboard do LookML, é necessário 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 a forma 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 do elemento. Se não for especificado, ele será definido como o modelo em que o dashboard reside.
- 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. O uso de uma constante permite definir o nome de um modelo em um só lugar, o que é particularmente útil se você estiver atualizando o nome de um modelo usado por vários elementos de 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
exploreparâmetro que 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 dashboard, descrito na página de documentação Parâmetros de dashboard.
O parâmetro explore define a análise a 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. O uso de uma constante permite definir o nome de uma análise em um só lugar, o que é particularmente útil se você estiver atualizando o nome de uma análise usada por vários elementos de 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 a dimensão ou dimensões a serem usadas para a consulta do elemento. Use a sintaxe view_name.dimension_name para especificar a dimensão. Não inclua dimensions se a consulta não tiver nenhuma.
## 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 a medida ou medidas a serem usadas para a consulta do elemento. Use a sintaxe view_name.measure_name para especificar a medida. Não inclua measures se a consulta não tiver nenhuma.
## 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 da consulta do elemento. Liste o campo de classificação principal primeiro, seguido por todos os campos de classificação secundários. Use a sintaxe view_name.field_name para especificar a dimensão ou medida a ser classificada.
Se você omitir o parâ0metro sorts, o elemento vai usar a ordem de classificação padrão do Looker. As classificações ascendentes não exigem um sufixo, enquanto as descendentes 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ê criar dimensões dinâmicas, poderá classificar os resultados da consulta especificando o nome da medida, a direção da classificação e o número de í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 para 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 do elemento. 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
filtersparâmetro que faz parte de um elemento do dashboard.
filterstambém pode ser usado como parte de um dashboard, descrito na página de documentação Parâmetros de dashboard.
filterstambém pode ser usado como parte de uma medida, descrito na página de documentação do parâmetrofilters.
O parâmetro filters define os filtros não mutáveis que devem ser usados para a consulta do elemento. Se você quiser filtros que um usuário possa mudar no dashboard, configure os filtros usando filters para dashboards 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 Liquid _localization ou _user_attributes na expressão de filtro para valores de filtro flexíveis.
listen
Os filtros de dashboard permitem que os leitores refinem interativamente os dados mostrados nos elementos do dashboard. Defina filtros de dashboard com o filters parâmetro para dashboards do LookML. Em seguida, use o parâmetro listen para vincular elementos de dashboard ao filtro do dashboard.
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 forneça o nome do filtro seguido por dois-pontos e uma referência ao campo a que o filtro deve ser aplicado, usando a sintaxe view_name.field_name. Por exemplo, é possível criar um filtro chamado Data que exige que um usuário insira uma data no campo de filtro na UI. Em seguida, aplique 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
...
Para outros exemplos de uso do parâmetro filters e do parâmetro listen para aplicar filtros de dashboard a elementos de dashboard 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 leitor, 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 mesclados 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 com base na Análise users no modelo ecommerce. A consulta principal 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 em valores correspondentes nos campos users.state e users.city.
O parâmetro listen aplica um filtro State a ambas as consultas, o que permite que os leitores do dashboard refinem os resultados da consulta mostrados no bloco do dashboard selecionando um estado específico.
Exemplo: mesclar dados da empresa
Suponha que você queira criar uma consulta mesclada que combine 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 nome da empresa, e-mail de contato da empresa, ano de IPO, símbolo de ações, número de funcionários e contagem de empregos. É 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
Aplicar filtros a elementos de consulta mesclada
O exemplo anterior de um elemento de consulta mesclada 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 principal 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 dashboard a elementos de consulta mesclada 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 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 em ambas as 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 mesclados 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 de dashboard Industry, a consulta de origem correspondente no elemento de consulta mesclada será filtrada de acordo.
hidden_fields
O parâmetro hidden_fields indica quais campos, se houver, são usados na consulta, mas ficam 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
Esta seção descreve os equivalentes do 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 nomes de colunas.
show_view_names: true | false
## default value: true