Em construção:estamos trabalhando para adicionar mais conteúdo a esta página. Enquanto isso, confira a página de documentação Opções de gráfico de linha do tempo para ver informações sobre como criar e editar gráficos de linha do tempo usando o menu de opções de visualização.
Os parâmetros descritos nesta página podem ser usados com elementos do painel da LookML de type: looker_timeline em um arquivo dashboard.lkml.
Para informações sobre como criar um gráfico de linha do tempo na interface do Looker, consulte a página de documentação Opções de gráfico de linha do tempo.
Parâmetros básicos
Ao definir um elemento de painel do LookML, você precisa especificar valores para pelo menos os parâmetros básicos name e type. Outros parâmetros básicos, como title, height e width, afetam a aparência e a posição de um elemento em um painel.
name
Esta seção se refere ao parâmetro
name, que faz parte de um elemento do painel.
nametambém pode ser usado como parte de um filtro do painel, descrito na página de documentação Parâmetros do painel.
Cada declaração name cria um novo elemento de painel 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.
- name: orders_by_date
title
Esta seção se refere ao parâmetro
title, que faz parte de um elemento do painel.
titletambém pode ser usado como parte de um painel, conforme descrito na página de documentação Parâmetros do painel.
titletambém pode ser usado como parte de um filtro do painel, descrito na página de documentação Parâmetros do painel.
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 vai usar o elemento name como padrão.
Por exemplo,
- name: sales_overview
title: '1) Sales Overview'
Se você usou esse formato, em vez de aparecer como Visão geral das vendas, o elemento apareceria como 1) Visão geral das vendas.
type
Esta seção se refere ao parâmetro
type, que faz parte de um elemento do painel.
typetambém pode ser usado como parte de um filtro do painel, descrito na página de documentação Parâmetros do painel.
typetambém pode ser usado como parte de uma junção, conforme descrito na página de documentação do parâmetrotype(para junções).
typetambém pode ser usado como parte de uma dimensão, conforme descrito na página de documentação Tipos de dimensões, filtros e parâmetros.
typetambém pode ser usado como parte de uma métrica, conforme descrito na página de documentação Tipos de métricas.
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 parâmetro
height, que faz parte de um elemento do painel.
heighttambém pode ser usado como parte de uma linha do painel, conforme descrito 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 painéis 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 dashboard com layout de jornal tem uma altura padrão de seis linhas ou cerca de 300 pixels. A altura mínima é de uma linha para painéis com um parâmetro preferred viewer definido como dashboards-next. A altura mínima é de duas linhas para painéis 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 seja, 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
width, que faz parte de um elemento do painel.
widthtambém pode ser usado como parte de um painel, conforme 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 painéis 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 painéis 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.
Um painel começa com a linha 0 na parte superior. Um dashboard com layout de jornal tem uma altura padrão de seis linhas. Isso significa que os elementos na parte superior de um dashboard (row: 0) ocupam as linhas de 0 a 5.
Cada linha tem 50 pixels de altura, o que significa que a altura padrão do elemento de seis linhas é de 300 pixels.
Por exemplo, o código a seguir define um elemento para ser colocado na segunda linha de elementos no painel, supondo que os elementos estejam definidos na altura padrão:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
row: 6
...
col
Para dashboards layout: newspaper, o parâmetro col define a coluna em que a borda esquerda do elemento é colocada.
Os painéis são divididos em 24 colunas. Um painel começa com a coluna 0 à esquerda. Um painel com layout de jornal tem uma largura de elemento padrão de oito colunas. Isso significa que os elementos à esquerda de um painel (col: 0) ocupam as colunas de 0 a 7 por padrão.
Por exemplo, o código a seguir define um elemento para ser definido 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
refresh, que faz parte de um elemento do painel.
refreshtambém pode ser usado como parte de um painel, conforme 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 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 mostrado 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 observação for muito longa, ela vai terminar em reticências clicáveis (...) que podem ser usadas para ler a observação completa.
display
O subparâmetro display determina onde a nota é mostrada 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 cursor do mouse sobre o elemento para ver a nota.
Parâmetros de consulta
Ao definir um elemento de dashboard do LookML do tipo type: looker_timeline, especifique valores para pelo menos os parâmetros de consulta model e explore. Sua consulta também precisa incluir valores para os parâmetros dimensions e measures, incluindo pelo menos uma dimensão que represente o campo de rótulo, como um nome, além de um campo de início e um campo de término, que podem ser uma data ou um número. Consulte a página de documentação Opções de gráfico de linha do tempo para mais informações sobre os requisitos mínimos para criar gráficos de linha do tempo no Looker.
model
O parâmetro model define o modelo a ser usado para a consulta de elemento. Se não for especificado, o padrão será o modelo em que o painel 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. Usar 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 do painel.
Para mais informações e um exemplo de uso de constantes com painéis do LookML, consulte a página de documentação do parâmetro constant.
explore
Esta seção se refere ao parâmetro
explore, que faz parte de um elemento do painel.
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 do painel, descrito na página de documentação Parâmetros do painel.
O parâmetro explore define a análise detalhada a ser usada para a consulta de 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. Usar uma constante permite definir o nome de uma análise detalhada em um só lugar, o que é particularmente útil se você estiver atualizando o nome de uma análise detalhada usada por vários elementos do painel.
Para mais informações e um exemplo de uso de constantes com painéis do LookML, consulte a página de documentação do parâmetro constant.
dimensions
O parâmetro dimensions define a dimensão ou as dimensões a serem usadas na consulta de elemento. 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 a métrica ou as métricas a serem 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 as classificações a serem usadas na consulta de elementos. A classificação principal é listada primeiro, seguida pela secundária e assim por diante. Use a sintaxe view_name.field_name para especificar a dimensão ou a métrica. Não inclua sorts se quiser usar a ordem de classificação padrão do Looker. As classificações em ordem decrescente têm o sufixo desc, e as em ordem crescente não precisam de um sufixo.
## single sort example
- name: orders_by_date
sorts: order.order_date desc
## multiple sort example
- name: orders_by_date
sorts: [order.order_date desc, customer.name]
pivots
O parâmetro pivots define as dimensões que precisam ser usadas como pivô na consulta de elemento. Use a sintaxe view_name.dimension_name para especificar a dimensão. Não inclua pivots se a consulta não tiver nenhum.
## single pivot example
- name: orders_by_date
pivots: customer.gender
## multiple pivot example
- name: orders_by_date
pivots: [customer.gender, customer.age_tier]
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 rotação.
- name: orders_by_date
limit: 100
filters
Esta seção se refere ao parâmetro
filters, que faz parte de um elemento do painel.
filterstambém pode ser usado como parte de um painel, conforme descrito na página de documentação Parâmetros do painel.
filterstambém pode ser usado como parte de uma métrica, conforme descrito na página de documentação do parâmetrofilters.
O parâmetro filters define os filtros não modificáveis que devem ser usados na consulta do elemento. Se você quiser filtros que um usuário possa mudar 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 Liquid _localization ou _user_attributes na expressão de filtro para valores flexíveis.
listen
Com os filtros do painel, os leitores podem refinar de forma interativa os dados mostrados nos elementos do painel. Defina filtros de dashboard com o parâmetro filters para dashboards do LookML. Em seguida, use o parâmetro listen para vincular elementos do painel 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 forneça o nome do filtro seguido por dois-pontos e uma referência ao campo em que o filtro deve ser aplicado, usando a sintaxe view_name.field_name. Por exemplo, você pode criar um filtro chamado Data que exige que um usuário insira uma data no campo de filtro da 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 mais exemplos de como usar os parâmetros filters e listen para aplicar filtros de painel a elementos individuais, consulte Criar painéis 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
Com o parâmetro merged_queries, é possível combinar os resultados de várias consultas em um único elemento do painel. 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 type: looker_grid de resultados combinados. Neste exemplo, o parâmetro merged_queries é usado para criar um elemento de painel 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 painel combina dados de duas consultas de origem baseadas na análise detalhada 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 nos valores correspondentes nos campos users.state e users.city.
O parâmetro listen aplica um filtro State às duas consultas, permitindo que os leitores do painel refinem os resultados da consulta mostrados no bloco do painel ao selecionar um estado específico.
Exemplo: como mesclar dados da empresa
Imagine que você queira criar uma consulta mesclada que combine informações sobre empresas de duas Análises diferentes: company_info e companies. Você quer combinar as consultas nos campos ipo.stock_symbol, companies.name e companies.contact_email de cada análise detalhada para criar uma consulta que retorne resultados para nome da empresa, e-mail de contato da empresa, ano da abertura de capital, símbolo da ação, número de funcionários e número de vagas. É possível definir o elemento de consulta mesclada em 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 combinados
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 com e-mails de contato e avaliações válidos. Esses filtros 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 aos 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 definido no nível do dashboard usando o parâmetro filters para dashboards da 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 código de amostra 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 do painel 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 ficam ocultos no gráfico. Todos os campos ocultos vão aparecer na seção de tabela de dados de uma análise detalhada.
hidden_fields: [inventory_items.count, distribution_centers.id]
Parâmetros de opção
A maioria dos parâmetros descritos nesta seção corresponde às opções na seção Opções do editor de visualização para gráficos de linha do tempo.
color_application
O parâmetro color_application e os subparâmetros collection_id e palette_id podem ser usados para aplicar uma coleção e uma paleta de cores específicas a um elemento do painel. Para uma visão geral das coleções de cores nativas do Looker, consulte a página de documentação Coleções de cores.
Se você tiver o ID da coleção e o ID da paleta que quer usar, insira esses IDs nos subparâmetros collection_id e palette_id. Um ID de coleção ou de paleta pode ser um código alfanumérico ou ter como base o nome da coleção de cores. Os códigos alfanuméricos são usados para as coleções nativas do Looker. Elas são específicas da instância e têm esta aparência:
color_application:
collection_id: 1297dk12-86a7-4xe0-8dfc-82de20b3806a
palette_id: 93c8aeb7-3f8a-4ca7-6fee-88c3617516a1
As coleções de cores personalizadas usam IDs de coleção e paleta com base no nome da coleção de cores, que são portáteis entre instâncias e têm esta aparência:
color_application:
collection_id: blue-tone-collection
palette_id: blue-tone-collection-categorical-0
Você também pode usar a UI para encontrar as cores, coleções ou paletas que quer e gerar a LookML para adicioná-las ao painel. Navegue até um conteúdo definido pelo usuário (como um Look, um painel ou uma análise detalhada) e aplique as cores, a coleção ou a paleta que você quer à visualização desse conteúdo usando a UI. Depois disso, siga as etapas para receber o LookML do painel, copie o LookML produzido e cole-o na seção color_application.
groupBars
Determine se a visualização deve mostrar cada barra de registro em uma linha própria ou se as barras de registro de cada valor de marcador devem estar na mesma linha. Se você definir groupBars como true, todos os registros que compartilham o mesmo valor de marcador vão aparecer como barras individuais na mesma linha da visualização.
groupBars: true | false
labelSize
Especifique um tamanho de fonte para os rótulos. Exemplo:
labelSize: 12pt
valueFormat
Especifique o formato de número ou data para o valor. O parâmetro aceita formatação no estilo Excel. Se nenhum formato for especificado, o valor será mostrado no formato da dimensão ou métrica subjacente.
showLegend
Mostra ou oculta uma legenda na parte de baixo da visualização.
showLegend: true | false