En construcción: Estamos trabajando para agregar más información a esta página. Mientras tanto, consulta la página de documentación Opciones de gráfico de un solo valor 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 deben usar con los elementos del panel de LookML de type: single_value en un archivo dashboard.lkml.
Para obtener información sobre cómo crear un gráfico de valor único a través de la IU de Looker, consulta la página de documentación Opciones de gráficos de valor único.
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 del panel.
nametambién se puede usar como parte de un filtro del panel, como se describe en la página de documentación Parámetros del panel.
Cada declaración de 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 parámetro elements cuando usas paneles de layout: grid.
- 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, como 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, como 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 elemento name.
Considera el siguiente ejemplo:
- name: sales_overview
title: '1) Sales Overview'
Si usaste 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 del panel.
typetambién se puede usar como parte de un filtro del panel, como se describe en la página de documentación Parámetros del panel.
typetambién se puede usar como parte de una unión, como 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, como 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, como 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 de type (para paneles de LookML) para obtener una descripción general de los diferentes tipos de elementos de paneles 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, como 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 de newspaper
El parámetro height define la altura de un elemento, en unidades de fila, para los paneles de layout: newspaper.
Un panel con diseño de periódico tiene una altura predeterminada de 6 filas, o alrededor de 300 píxeles. La altura mínima es de 1 fila para los paneles con un parámetro preferred viewer 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, como 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, y 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
En el caso de los paneles de 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. 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 (row: 0) ocuparían de forma predeterminada las filas de la 0 a la 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 establecen en la altura predeterminada:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
row: 6
...
col
En el caso de los paneles de 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 de forma predeterminada un ancho de elemento de 8 columnas, lo que significa que los elementos del panel a la izquierda de un panel (col: 0) ocuparían de forma predeterminada las columnas de la 0 a la 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, como 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 y, de este modo, recupere datos nuevos. Esto suele ser útil en entornos en los que se muestra un panel de forma constante, como en la TV de una 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 de configuración 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 al establecer 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 parámetro secundario 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á con puntos suspensivos (...) en los que se puede hacer clic 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 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 parámetros de consulta model y explore, 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 del elemento. Si no se especifica, se usará de forma predeterminada 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. Usar una constante te permite definir el nombre de un modelo en un solo lugar, lo que resulta especialmente ú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 los 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, como se describe en la página de documentación del parámetroexplore.
exploretambién se puede usar como parte de un filtro del panel, como se describe en la página de documentación Parámetros del panel.
El parámetro explore define el Explorar que se usará para la consulta del elemento.
- 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. Usar una constante te permite definir el nombre de un Explore en un solo lugar, lo que es particularmente útil si actualizas el nombre de un Explore que usan varios elementos del panel.
Para obtener más información y un ejemplo del uso de constantes con los 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 del elemento. Usa la sintaxis view_name.dimension_name para especificar la dimensión. No incluyas dimensions si la búsqueda no tiene ninguno.
## 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 métrica o las métricas que se usarán para la consulta del elemento. Usa la sintaxis view_name.measure_name para especificar la métrica. No incluyas measures si la búsqueda no tiene ninguno.
## 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 las ordenaciones que se usarán para la consulta de elementos. El ordenamiento principal aparece primero, luego el secundario, y así sucesivamente. Usa la sintaxis view_name.field_name para especificar la dimensión o la métrica. No incluyas sorts si deseas usar el orden de clasificación predeterminado de Looker. Los ordenamientos descendentes tienen el sufijo desc, mientras que los ascendentes no lo necesitan.
## 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
El parámetro pivots define las dimensiones que se deben segmentar para la consulta de elementos. Usa la sintaxis view_name.dimension_name para especificar la dimensión. No incluyas pivots si la búsqueda no tiene ninguno.
## single pivot example
- name: orders_by_date
pivots: customer.gender
## multiple pivot example
- name: orders_by_date
pivots: [customer.gender, customer.age_tier]
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 tablas dinámicas.
- 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, como se describe en la página de documentación Parámetros del panel.
filterstambién se puede usar como parte de una métrica, como 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 filtros que un usuario pueda cambiar en el panel, debes configurarlos con filters para 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 filtros de 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 el usuario ingrese una fecha en el campo de filtro de la IU. Luego, podrías 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 sobre el uso del parámetro filters y el parámetro listen para aplicar filtros del panel a elementos individuales del panel, consulta Cómo compilar paneles de LookML.
query_timezone
El parámetro query_timezone especifica la zona horaria en la que se ejecutará la búsqueda. 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 búsquedas 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 ejemplo de LookML, se crea un elemento de type: looker_grid de resultados combinados. En este ejemplo, el parámetro merged_queries se usa 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 basadas en la función users Explorar del 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 la tarjeta del panel seleccionando un estado específico.
Ejemplo: Combinación de datos de la empresa
Supongamos que deseas crear una consulta combinada que incluya información sobre empresas de dos exploraciones diferentes: company_info y companies. Quieres unir las consultas en los campos ipo.stock_symbol, companies.name y companies.contact_email de cada Explorar para crear una consulta que devuelva 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 el recuento de empleos. 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 consultas combinadas
En el ejemplo anterior de un elemento de búsqueda combinado, se muestra cómo aplicar filtros codificados directamente dentro de cada búsqueda 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 valoraciones válidos. Estos filtros a nivel de la consulta filtran previamente los datos antes de combinar las consultas y el usuario no los puede cambiar.
También puedes aplicar filtros del panel a los elementos de consultas combinadas con el parámetro listen dentro de la definición de cada consulta de origen. Por ejemplo, supongamos que tienes un filtro de 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 las consultas de origen de la consulta combinada de la siguiente manera:
listen:
Industry: companies.industry
Por ejemplo, el siguiente código de ejemplo 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 incorporació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 búsqueda, pero están ocultos en el gráfico. Los campos ocultos aparecerán en la sección de la tabla de datos de un Explorar.
hidden_fields: [inventory_items.count, distribution_centers.id]
Parámetros de diseño
Los parámetros que se describen en esta sección corresponden a las opciones de la sección Estilo del editor de visualizaciones para los gráficos de un solo valor.
colors
El parámetro colors especifica una lista de colores para la serie. El primer color de la lista corresponde a la primera serie de datos. Si hay más series que colores enumerados, los colores volverán a comenzar desde el principio.
colors: [blue, orange, yellow, red, purple]
Para todos los atributos del gráfico que especifican un color, el valor del color puede tomar una cadena hexadecimal, como #2ca6cd, o una cadena de color con nombre CSS, como mediumblue.
custom_color_enabled
Si estableces el parámetro custom_color_enabled en true, se habilita la opción para especificar un color personalizado para una visualización de un solo valor. Usa este parámetro con el parámetro custom_color.
custom_color_enabled: true | false
custom_color
Especifica un color personalizado para el texto en una visualización de un solo valor.
custom_color: #2ca6cd | mediumblue
show_single_value_title
Cuando este parámetro se establece en true, se muestra un título debajo del valor de la búsqueda. Puedes especificar o cambiar el título con el parámetro single_value_title.
show_single_value_title: true | false
single_value_title
Especifica un título para mostrar con el valor de la búsqueda. El texto del título se puede localizar.
single_value_title: Title
valueFormat
Especifica el formato de número o de fecha para el valor. El parámetro acepta el formato de Excel. Si no se especifica ningún formato, el valor se mostrará en el formato de la dimensión o métrica subyacente.
Parámetros de comparación
Los parámetros que se describen en esta sección corresponden a las opciones de la sección Comparación del editor de visualizaciones para los gráficos de un solo valor.
show_comparison
Cuando se establece en true, el parámetro show_comparison te permite agregar información de comparación a un elemento del panel de type: single_value.
show_comparison: true | false
comparison_type
Usa el parámetro comparison_type para especificar cómo se usa el campo de comparación en un elemento del panel de type: single_value.
Puedes especificar uno de los siguientes valores para el parámetro comparison_type:
value: El valor del campo de comparación se muestra en la parte inferior de la visualización.change: El valor del campo de comparación se muestra en la parte inferior de la visualización. Si el valor es negativo, un triángulo apunta hacia abajo. Si el valor es positivo, el triángulo apunta hacia arriba.progress: El valor del campo que se usa para la visualización de un solo valor se divide por el valor del campo de comparación. Este porcentaje se muestra como una barra de progreso.progress_percentage: El valor del campo que se usa para la visualización de un solo valor se divide por el valor del campo de comparación. Este porcentaje se muestra como una barra de progreso. La barra está etiquetada con el porcentaje y el valor del campo de comparación.
comparison_type: value | change | progress | progress_percentage
show_comparison_label
Especifica si se muestra una etiqueta con el campo de comparación. De forma predeterminada, la etiqueta es el nombre del campo de comparación.
show_comparison_label: true | false
comparison_label
Especifica la etiqueta que se mostrará con el campo de comparación. El texto de la etiqueta de comparación se puede localizar.
show_comparison_label: true
comparison_label: Label
comparison_reverse_colors
Si comparison_type se establece en change, puedes establecer comparison_reverse_colors en true para mostrar los números negativos en un campo de comparación como texto verde con un triángulo verde, mientras que los números positivos aparecen como texto rojo con un triángulo rojo.
comparison_type: change
comparison_reverse_colors: true | false