En construcción: Estamos trabajando para agregar más contenido a esta página. Mientras tanto, consulta la página de documentación Opciones de gráficos de un solo registro para ver información sobre cómo crear y editar visualizaciones de un solo valor con el menú de opciones de visualización.
Los parámetros que se describen en esta página se usan con los elementos del panel de LookML de type: looker_single_record en un dashboard.lkml archivo.
Para obtener información sobre cómo crear un gráfico de un solo registro a través de la IU de Looker, consulta la página de documentación Opciones de gráficos de un solo registro.
Parámetros básicos
Cuando defines un elemento del panel de LookML, debes especificar valores para al menos los parámetros name y type. Otros parámetros básicos, como title, height y width, afectan la posición y la apariencia de un elemento en un panel.
name
En esta sección, se hace referencia al parámetro
nameque forma parte de un elemento de panel .
nametambién se puede usar como parte de un filtro del panel, que se describe en la página de documentación Parámetros del panel.
Cada declaración name crea un nuevo elemento del panel y le asigna un nombre. Los nombres de los elementos deben ser únicos. A veces, se hace referencia a los nombres en el elements parámetro cuando usas layout: grid paneles.
- name: orders_by_date
title
En esta sección, se hace referencia al parámetro
titleque forma parte de un elemento del panel.
titletambién se puede usar como parte de un panel, que se describe en la página de documentación Parámetros del panel.
titletambién se puede usar como parte de un filtro del panel, que se describe en la página de documentación Parámetros del panel.
El parámetro title te permite cambiar la forma en que aparecerá el nombre de un elemento para los usuarios. Si no se especifica, el título se establece de forma predeterminada en el name del elemento.
Considera el siguiente ejemplo:
- name: sales_overview
title: '1) Sales Overview'
Si usaras este formato, en lugar de que el elemento aparezca como Resumen de ventas, aparecería como 1) Resumen de ventas.
type
En esta sección, se hace referencia al parámetro
typeque forma parte de un elemento de panel .
typetambién se puede usar como parte de un filtro del panel, que se describe en la página de documentación Parámetros del panel.
typetambién se puede usar como parte de una unión, que se describe en la página de documentación del parámetrotype(para uniones).
typetambién se puede usar como parte de una dimensión, que se describe en la página de documentación Tipos de dimensiones, filtros y parámetros.
typetambién se puede usar como parte de una medida, que se describe en la página de documentación Tipos de medidas.
El parámetro type determina el tipo de visualización que se usará en el 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
Consulta la página de documentación type (para paneles de LookML) para obtener una descripción general de los diferentes tipos de elementos del panel de LookML.
height
En esta sección, se hace referencia al parámetro
heightque forma parte de un elemento del panel.
heighttambién se puede usar como parte de una fila del panel, que se describe en la página de documentación Parámetros del panel.
Para paneles con diseños tile o static
El parámetro height define la altura de un elemento, en unidades de tile_size (que se define en píxeles), para los paneles layout: tile y layout: static.
Por ejemplo, el siguiente código especifica tile_size: 100 y height: 4, lo que hace que el elemento orders_by_date tenga 400 píxeles de altura.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
height: 4
...
Para paneles con diseño newspaper
El parámetro height define la altura de un elemento, en unidades de fila, para los paneles layout: newspaper.
Un panel con diseño de periódico tiene una altura predeterminada de 6 filas, o aproximadamente 300 píxeles. La altura mínima es de 1 fila para los paneles con un preferred viewer parámetro establecido en dashboards-next. La altura mínima es de 2 filas para los paneles con un parámetro preferred viewer establecido en dashboards.
Por ejemplo, el siguiente código establece que un elemento tenga 12 filas de alto, o el doble de alto que otros elementos que se establecen en el valor predeterminado:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
height: 12
...
width
En esta sección, se hace referencia al parámetro
widthque forma parte de un elemento del panel .
widthtambién se puede usar como parte de un panel, que se describe en la página de documentación Parámetros del panel.
El parámetro width define el ancho de un elemento, en unidades de tile_size, para los paneles layout: tile y layout: static.
Por ejemplo, el siguiente código especifica tile_size: 100 y width: 4, lo que hace que el elemento orders_by_date tenga 400 píxeles de ancho.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
width: 4
...
El parámetro width define el ancho de un elemento, en unidades de columnas, para los paneles layout: newspaper.
Un panel con diseño de periódico tiene un ancho predeterminado de 24 columnas.
Por ejemplo, el siguiente código establece el elemento en la mitad del ancho del panel:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
width: 12
...
top
El parámetro top define la posición de arriba hacia abajo de un elemento, en unidades de tile_size, para los paneles layout: static.
Por ejemplo, el siguiente código especifica tile_size: 100 y top: 4, lo que posiciona el borde superior del elemento orders_by_date a 400 píxeles de la parte superior del panel.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
top: 4
...
left
El parámetro left define la posición de izquierda a derecha de un elemento, en unidades de tile_size, para los paneles layout: static.
Por ejemplo, el siguiente código especifica tile_size: 100 y left: 4, lo que posiciona el borde izquierdo del elemento orders_by_date a 400 píxeles del lado izquierdo del panel.
- dashboard: sales_overview
tile_size: 100
...
elements:
- name: orders_by_date
left: 4
...
row
Para los paneles layout: newspaper, el parámetro row define la fila en la que se coloca el borde superior de un elemento.
Un panel comienza con la fila 0 en la parte superior del panel. Un panel con diseño de periódico tiene una altura predeterminada de 6 filas, lo que significa que los elementos del panel en la parte superior de un panel (row: 0) se establecerían de forma predeterminada para ocupar las filas 0 a 5.
Cada fila tiene 50 píxeles de alto, lo que significa que la altura predeterminada del elemento de 6 filas es de 300 píxeles.
Por ejemplo, el siguiente código establece que un elemento se coloque en la segunda fila de elementos del panel, suponiendo que los elementos se establezcan en la altura predeterminada:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
row: 6
...
col
Para los paneles layout: newspaper, el parámetro col define la columna en la que se coloca el borde izquierdo del elemento.
Los paneles se dividen en 24 columnas. Un panel comienza con la columna 0 a la izquierda del panel. Un panel con diseño de periódico tiene un ancho predeterminado de 8 columnas, lo que significa que los elementos del panel a la izquierda de un panel (col: 0) se establecerían de forma predeterminada para ocupar las columnas 0 a 7.
Por ejemplo, el siguiente código establece que un elemento se coloque en la tercera columna de elementos del panel:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
col: 16
...
refresh
En esta sección, se hace referencia al parámetro
refreshque forma parte de un elemento del panel.
refreshtambién se puede usar como parte de un panel, que se describe en la página de documentación Parámetros del panel.
El parámetro refresh permite que un elemento se vuelva a cargar automáticamente de forma periódica, lo que permite recuperar datos nuevos. Esto suele ser útil en la configuración en la que se muestra un panel de forma constante, como en un televisor de oficina. Ten en cuenta que el panel debe estar abierto en una ventana del navegador para que este parámetro tenga efecto. Este parámetro no se ejecuta en segundo plano para "precalentar" la caché del panel.
La frecuencia de actualización puede ser cualquier número (sin decimales) de segundos, minutos, horas o días. Por ejemplo:
- name: orders_by_date
refresh: 2 hours
Ten cuidado cuando establezcas intervalos de actualización cortos. Si la consulta detrás del elemento requiere muchos recursos, es posible que ciertos elementos sobrecarguen tu base de datos más de lo deseado.
note
Puedes agregar notas descriptivas a los elementos de la siguiente manera:
- name: element_name
note:
text: 'note text'
state: collapsed | expanded
display: above | below | hover
note tiene los subparámetros text, state y display.
text
El subparámetro text especifica el texto que se muestra en la nota. El texto se puede localizar.
state
El subparámetro state determina si la nota será collapsed o expanded si es demasiado grande para caber en una sola fila dentro del ancho del elemento. Si eliges collapsed y la nota es demasiado larga, terminará en puntos suspensivos en los que se puede hacer clic (...) que se pueden usar para leer la nota completa.
display
El subparámetro display determina dónde se muestra la nota en un elemento. above coloca la nota en la parte superior de un elemento, below la coloca en la parte inferior de un elemento y hover requiere que el usuario coloque el cursor sobre el elemento para ver la nota.
Parámetros de consulta
Cuando defines un elemento del panel de LookML, debes especificar valores para al menos los model y explore parámetros de consulta, y se debe especificar al menos un campo con el parámetro dimensions o el parámetro measures. También puedes usar los otros parámetros de consulta para controlar la forma en que se muestran los datos en un elemento del panel.
model
El parámetro model define el modelo que se usará para la consulta de elementos. Si no se especifica, se establecerá de forma predeterminada en el modelo en el que reside el panel.
- name: orders_by_date
model: ecommerce
El parámetro model acepta constantes de LookML. Puedes definir una constante en el archivo de manifiesto de tu proyecto y, luego, usar la sintaxis "@{constant_name}" para establecer la constante como el valor de model. El uso de una constante te permite definir el nombre de un modelo en un solo lugar, lo que es particularmente útil si actualizas el nombre de un modelo que usan varios elementos del panel.
Para obtener más información y un ejemplo del uso de constantes con paneles de LookML, consulta la página de documentación del parámetro constant.
explore
En esta sección, se hace referencia al parámetro
exploreque forma parte de un elemento del panel.
exploretambién se puede usar como parte de un modelo, que se describe en la página de documentación del parámetroexplore.
exploretambién se puede usar como parte de un filtro del panel, que se describe en la página de documentación Parámetros del panel.
El parámetro explore define la exploración que se usará para la consulta de elementos.
- name: orders_by_date
explore: order
El parámetro explore acepta constantes de LookML. Puedes definir una constante en el archivo de manifiesto de tu proyecto y, luego, usar la sintaxis "@{constant_name}" para establecer la constante como el valor de explore. El uso de una constante te permite definir el nombre de una exploración en un solo lugar, lo que es particularmente útil si actualizas el nombre de una exploración que usan varios elementos del panel.
Para obtener más información y un ejemplo del uso de constantes con paneles de LookML, consulta la página de documentación del parámetro constant.
dimensions
El parámetro dimensions define la dimensión o las dimensiones que se usarán para la consulta de elementos. Usa la sintaxis view_name.dimension_name para especificar la dimensión. No incluyas dimensions si la consulta no tiene ninguna.
## 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
El parámetro measures define la medida o las medidas que se usarán para la consulta de elementos. Usa la sintaxis view_name.measure_name para especificar la medida. No incluyas measures si la consulta no tiene ninguna.
## single measure example
- name: orders_by_date
measures: order.count
## multiple measure example
- name: orders_by_date
measures: [order.count, order_item.count]
sorts
El parámetro sorts define el comportamiento de ordenamiento para la consulta del elemento. Primero, enumera el campo de ordenamiento principal, seguido de los campos de ordenamiento secundarios. Usa la sintaxis view_name.field_name para especificar la dimensión o la medida por la que se ordenará.
Si omites el parámetro sorts, el elemento usa el orden de clasificación predeterminado de Looker. Los ordenamientos ascendentes no requieren un sufijo, mientras que los ordenamientos descendentes requieren el sufijo desc.
En el siguiente ejemplo, se define un solo ordenamiento:
- name: orders_by_date
sorts: order.order_date desc
En el siguiente ejemplo, se definen varios ordenamientos:
- name: orders_by_date
sorts: [order.order_date desc, customer.name]
Si dinamizas dimensiones, puedes ordenar los resultados de la consulta especificando el nombre de la medida, la dirección de ordenamiento y el número de índice basado en 0 de la columna de destino en la tabla de datos. Por ejemplo, el siguiente elemento ordena por la primera columna dinámica con el índice 0:
- name: orders_by_category
sorts: [orders.count desc 0]
Para ordenar por el total de la fila, especifica el índice de la columna de totales. Por ejemplo, el siguiente elemento ordena por el total de la fila con el índice 2, que representa la columna de totales para una consulta con dos columnas dinámicas:
- name: orders_by_cohort
sorts: [users.count desc 2]
limit
El parámetro limit define el límite de filas que se debe usar para la consulta de elementos. El límite se aplica a la cantidad de filas antes de que se apliquen las dinamizaciones.
- name: orders_by_date
limit: 100
filters
En esta sección, se hace referencia al parámetro
filtersque forma parte de un elemento del panel.
filterstambién se puede usar como parte de un panel, que se describe en la página de documentación Parámetros del panel.
filterstambién se puede usar como parte de una medida, que se describe en la página de documentación del parámetrofilters.
El parámetro filters define los filtros no modificables que se deben usar para la consulta del elemento. Si deseas que un usuario pueda cambiar los filtros en el panel, debes configurarlos con filters para los paneles y, luego, aplicarlos a los elementos con listen.
La sintaxis de filters es la siguiente:
- name: element_name
filters:
orders.created_date: 2020/01/10 for 3 days
orders.status: Shipped
# You can create multiple filter statements
Cada filtro puede aceptar una expresión de filtro de Looker o una constante de valor. También puedes usar las variables de Liquid _localization o _user_attributes en la expresión de filtro para obtener valores de filtro flexibles.
listen
Los filtros del panel permiten que los usuarios refinen de forma interactiva los datos que se muestran en los elementos del panel. Define los filtros del panel con el parámetro filters para los paneles de LookML. Luego, usa el parámetro listen para vincular los elementos del panel al filtro del panel.
La sintaxis de listen es la siguiente:
- 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
Agrega el parámetro listen a un elemento y, luego, proporciona el nombre del filtro seguido de dos puntos y una referencia al campo al que se debe aplicar el filtro con la sintaxis view_name.field_name. Por ejemplo, puedes crear un filtro llamado Fecha que requiera que un usuario ingrese una fecha en el campo de filtro de la IU. Luego, puedes aplicar el valor que ingresa el usuario al elemento orders_by_date de la siguiente manera:
- dashboard: sales_overview
...
filters:
- name: date
type: date_filter
elements:
- name: orders_by_date
listen:
date: order.order_date
...
Para obtener ejemplos adicionales del uso del parámetro filters y el parámetro listen para aplicar filtros del panel a elementos individuales del panel, consulta Cómo crear paneles de LookML.
query_timezone
El parámetro query_timezone especifica la zona horaria en la que se ejecutará la consulta. Las opciones de zona horaria se muestran en la página de documentación Valores para timezone. Si deseas que la consulta se ejecute con la zona horaria del usuario, puedes asignar el valor como user_timezone.
- name: orders_by_date
query_timezone: America/Los Angeles
- name: orders_by_customer
query_timezone: user_timezone
merged_queries
El parámetro merged_queries te permite combinar los resultados de varias consultas en un solo elemento del panel. Define cada consulta de origen dentro del parámetro merged_queries del elemento y usa el subparámetro join_fields para especificar cómo se deben combinar los resultados.
En el siguiente código de LookML de muestra, se crea un elemento de resultados combinados de type: looker_grid. En este ejemplo, se usa el parámetro merged_queries para crear un elemento del panel que combina datos de dos consultas separadas en un solo gráfico de tabla:
- 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
En este ejemplo, el elemento del panel combina datos de dos consultas de origen que se basan en la exploración users en el modelo ecommerce. La consulta principal incluye los campos users.state, users.count y users.city, y ordena los resultados por el campo users.count. La segunda consulta de origen incluye los campos users.state y users.city, y ordena los resultados por el campo users.state.
El parámetro join_field combina las consultas de origen en función de los valores coincidentes en los campos users.state y users.city.
El parámetro listen aplica un filtro State a ambas consultas, lo que permite que los usuarios del panel refinen los resultados de la consulta que se muestran en el campo del panel seleccionando un estado específico.
Ejemplo: Cómo combinar datos de la empresa
Supongamos que deseas crear una consulta combinada que combine información sobre empresas de dos exploraciones diferentes: company_info y companies. Deseas unir las consultas en los campos ipo.stock_symbol, companies.name y companies.contact_email de cada exploración para crear una consulta que muestre resultados para el nombre de la empresa, el correo electrónico de contacto de la empresa, el año de la OPI, el símbolo bursátil, la cantidad de empleados y la cantidad de trabajos. Puedes definir el elemento de consulta combinada en LookML de la siguiente manera:
- 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
Cómo aplicar filtros a elementos de consulta combinados
En el ejemplo anterior de un elemento de consulta combinada, se muestra cómo aplicar filtros codificados directamente dentro de cada consulta de origen con el parámetro filters. Por ejemplo, los filtros companies.contact_email: "-NULL" y ipo.valuation_amount: NOT NULL en la consulta principal restringen los resultados a las empresas que tienen correos electrónicos de contacto y valuaciones válidos. Estos filtros a nivel de la consulta filtran previamente los datos antes de combinar las consultas y el usuario no puede cambiarlos.
También puedes aplicar filtros del panel a elementos de consulta combinados con el parámetro listen dentro de la definición de cada consulta de origen. Por ejemplo, supongamos que tienes un filtro del panel llamado Industry que definiste a nivel del panel con el parámetro filters para los paneles de 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 el filtro Industry al campo companies.industry en ambas consultas de origen, agrega el parámetro listen a cada una de las definiciones de consulta de origen de la consulta combinada de la siguiente manera:
listen:
Industry: companies.industry
Por ejemplo, el siguiente código de muestra agrega el filtro Industry a ambas consultas de origen en el elemento de resultados combinados del ejemplo 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
Con esta adición, cuando un usuario interactúe con el filtro del panel Industry, la consulta de origen correspondiente en el elemento de consulta combinada se filtrará según corresponda.
hidden_fields
El parámetro hidden_fields indica qué campos, si los hay, se usan en la consulta, pero están ocultos en el gráfico. Cualquier campo oculto aparecerá en la sección de la tabla de datos de una exploración.
hidden_fields: [inventory_items.count, distribution_centers.id]
Parámetros de un solo registro
En esta sección, se describen los equivalentes de LookML de las opciones del menú Editar para los gráficos de un solo registro.
show_view_names
El parámetro show_view_names determina si los nombres de las vistas se muestran en las etiquetas de los gráficos, como los nombres de los ejes y los nombres de las columnas.
show_view_names: true | false
## default value: true