En construcción: Estamos trabajando para agregar más elementos a esta página. Mientras tanto, consulta la página de documentación Opciones del gráfico de cronograma para ver información sobre cómo crear y editar gráficos de cronograma mediante el menú de opciones de visualización.
Los parámetros que se describen en esta página se pueden usar con los elementos del panel de LookML de type: looker_timeline
en un archivo dashboard.lkml
.
Para obtener información sobre cómo crear un gráfico de cronograma a través de la IU de Looker, consulta la página de documentación Opciones del gráfico de cronograma.
Parámetros básicos
Cuando defines un elemento del panel de LookML, debes especificar valores para los parámetros básicos name
y type
como mínimo. Otros parámetros básicos, como title
, height
y width
, afectan la apariencia y la posición de un elemento en un panel.
name
En esta sección, se hace referencia al parámetro
name
que forma parte de un elemento del panel.
name
tambié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 elemento de panel nuevo 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 se usan los paneles layout: grid
.
- name: orders_by_date
title
En esta sección, se hace referencia al parámetro
title
que forma parte de un elemento del panel.
title
también se puede usar como parte de un panel, que se describe en la página de documentación Parámetros del panel.
title
tambié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 se muestra el nombre de un elemento a los usuarios. Si no se especifica, el título se establece de forma predeterminada con el elemento name
.
Considera el siguiente ejemplo:
- name: sales_overview
title: '1) Sales Overview'
Si utilizó este formato, en lugar del elemento que aparece como Descripción general de las ventas, aparecerá como 1) Descripción general de las ventas.
type
En esta sección, se hace referencia al parámetro
type
que forma parte de un elemento del panel.
type
tambié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.
type
también se puede usar como parte de una unión, que se describe en la página de documentación del parámetrotype
(para combinaciones).
type
también se puede usar como parte de una dimensión, que se describe en la página de documentación Dimensión, filtro y tipos de parámetros.
type
también se puede usar como parte de una medida, que se describe en la página de documentación Tipos de medición.
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) a fin de 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
height
que forma parte de un elemento del panel.
height
también se puede usar como parte de una fila del panel, descrita en la página de documentación Parámetros del panel.
Para paneles con diseños de 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 el diseño newspaper
El parámetro height
define la altura de un elemento, en unidades de fila, para los paneles layout: newspaper
.
De forma predeterminada, un panel con diseño de periódico tiene una altura 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 altura que otros elementos que tienen la configuración predeterminada:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
height: 12
...
width
En esta sección, se hace referencia al parámetro
width
que forma parte de un elemento del panel.
width
tambié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 columna, para los paneles de layout: newspaper
.
De forma predeterminada, el panel tiene un ancho 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 de layout: static
.
Por ejemplo, el siguiente código especifica tile_size: 100
y top: 4
, y coloca el borde superior del elemento orders_by_date
400 píxeles desde 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 de 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 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 del panel. De forma predeterminada, un panel con diseño de periódico tiene una altura de 6 filas, lo que significa que los elementos de panel en la parte superior de un panel (row: 0
) ocuparán de forma predeterminada las filas 0-5.
Cada fila tiene 50 píxeles de alto, lo que significa que la altura predeterminada de 6 filas es de 300 píxeles.
Por ejemplo, en el siguiente código, se configura un elemento que se establecerá 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
Para los paneles de layout: newspaper
, el parámetro col
define la columna en la que se coloca el borde izquierdo del elemento.
Los paneles de control se dividen en 24 columnas. Un panel comienza con la columna 0 a la izquierda del panel. De manera predeterminada, un panel con diseño de periódico tiene un ancho de 8 columnas, lo que significa que los elementos del panel a la izquierda de un panel (col: 0
) usarán las columnas 0 a 7 de forma predeterminada.
Por ejemplo, el siguiente código establece un elemento que se establecerá en la tercera columna de elementos en el panel:
- dashboard: sales_overview
layout: newspaper
...
elements:
- name: orders_by_date
col: 16
...
refresh
En esta sección, se hace referencia al parámetro
refresh
que forma parte de un elemento del panel.
refresh
tambié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 recupera datos nuevos. Esto suele ser útil en entornos en los que el panel de control se muestra constantemente, por ejemplo, en la televisión de una oficina. Ten en cuenta que, para que este parámetro tenga efecto, el panel debe estar abierto en una ventana del navegador. Esta 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 cuando configures intervalos cortos de actualización. Si la consulta detrás del elemento requiere una gran cantidad de recursos, ciertos elementos pueden ejercer más esfuerzo sobre la base de datos.
note
Puedes agregar notas descriptivas a elementos como los siguientes:
- 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, esta 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 desplace el mouse sobre el elemento para ver la nota.
Parámetros de consulta
Cuando defines un elemento del panel de LookML de type: looker_timeline
, debes especificar valores para al menos los parámetros de búsqueda model
y explore
. Tu consulta también debe incluir valores para los parámetros dimensions
y measures
, incluidas al menos una dimensión que represente el campo de la etiqueta, como un nombre, así como un campo inicial y uno final, que pueden ser una fecha o un número. Consulta la página de documentación de opciones de gráficos de cronograma a fin de obtener más información sobre los requisitos mínimos para crear gráficos de cronograma en Looker.
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 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
explore
que forma parte de un elemento del panel.
explore
también se puede usar como parte de un modelo, que se describe en la página de documentación del parámetroexplore
.
explore
tambié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 el uso de Explorar 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
. 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 utilizan 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 las dimensiones que se usarán en la consulta del elemento. Usa la sintaxis view_name.dimension_name
para especificar la dimensión. No incluyas dimensions
si la consulta 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 las medidas que se usarán para la consulta del elemento. Usa la sintaxis view_name.measure_name
para especificar la medida. No incluyas measures
si la consulta 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 clasificaciones que se usarán para la consulta del elemento. Primero se ordena la principal, luego la secundaria y así sucesivamente. Usa la sintaxis view_name.field_name
para especificar la dimensión o la medida. No incluyas sorts
si quieres usar el orden de clasificación predeterminado de Looker. Los órdenes descendentes tienen el sufijo desc
; los ascendentes no necesitan un sufijo.
## 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 girar para la consulta del elemento. Usa la sintaxis view_name.dimension_name
para especificar la dimensión. No incluyas pivots
si la consulta 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 del elemento. El límite se aplica a la cantidad de filas antes de que se apliquen los pivotes.
- name: orders_by_date
limit: 100
filters
En esta sección, se hace referencia al parámetro
filters
que forma parte de un elemento del panel.
filters
también se puede usar como parte de un panel, que se describe en la página de documentación Parámetros del panel.
filters
tambié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 desea usar filtros que un usuario puede cambiar en el panel, debe configurar los filtros con filters
para los paneles y, luego, aplicarlos a los elementos mediante 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 filtros de Looker o una constante de valor. También puedes usar las variables líquidas _localization
o _user_attributes
en la expresión de filtro para valores de filtro flexibles.
listen
Los paneles pueden tener filtros que permiten a los usuarios cambiar los datos que se encuentran detrás de los elementos del panel. Estas se configuran mediante el parámetro filters
para paneles. Para que un filtro afecte a un elemento, este debe configurarse en "escuchar" ese filtro mediante el parámetro listen
.
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
Por ejemplo, puedes crear un filtro llamado Date que requiera que un usuario ingrese una fecha en el campo de filtro en la IU. Luego, puedes aplicar el valor que el usuario ingresa en el 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
...
Este concepto se describe con más detalle en la página de documentación Cómo compilar 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 de timezone
. Si quieres 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
define cómo combinar los resultados de varias consultas. Debes definir las consultas de los componentes en el parámetro merged_queries
y usar el subparámetro join_fields
para definir las reglas de fusión.
La sintaxis de merged_queries
es la siguiente:
merged_queries:
- 'primary query definition'
- 'next source query definition'
join_fields:
- field_name: 'field from the source query using the view_name.field_name syntax'
source_field_name: 'joined field from the primary query using the
view_name.field_name syntax'
# more join_fields definitions as needed
- 'next source query definition'
join_fields:
- field_name: view_name.field_name
source_field_name: view_name.field_name
# more join_fields definitions as needed
# additional source queries and join_fields definitions as needed
La primera consulta definida en merged_results
es la consulta principal y las demás consultas se combinarán con esa.
Por ejemplo, si te unes al símbolo de acciones, al nombre de la empresa y al nombre de usuario de Twitter, puedes combinar dos consultas para mostrar los resultados por nombre de la empresa, nombre de usuario de la empresa en Twitter, año de oferta pública inicial, símbolo de acciones, cantidad de empleados y recuento de trabajos:
- name: merged_results_element
title: Merged Results Tile
merged_queries:
- model: market_research
explore: company_info
fields: [company.name, company.twitter_username, ipo.public_year, ipo.stock_symbol]
filters:
company.twitter_username: "-NULL"
ipo.valuation_amount: NOT NULL
sorts: [ipo.public_year desc]
- model: crunchbase
explore: companies
fields: [companies.name, ipo.stock_symbol, companies.twitter_username,
companies.number_of_employees, jobs.job_count]
filters:
companies.number_of_employees: NOT NULL
ipo.stock_symbol: "-NULL"
companies.twitter_username: "-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: company.name
- field_name: companies.twitter_username
source_field_name: company.twitter_username
Los resultados de datos tendrán el siguiente formato:
Luego, puede aplicar parámetros de elementos para diseñar la visualización como desee.
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. Los campos ocultos aparecerán en la sección de tabla de datos de Explorar.
hidden_fields: [inventory_items.count, distribution_centers.id]
Parámetros de opción
La mayoría de los parámetros descritos en esta sección corresponden a las opciones de la sección Opciones del editor de visualización para los gráficos de cronograma.
color_application
El parámetro color_application
, y sus subparámetros collection_id
y palette_id
, se pueden usar para aplicar una colección de colores y una paleta específicas a un elemento del panel. Para obtener una descripción general de las colecciones de colores nativos de Looker, consulta la página de documentación Colecciones de color.
Si tienes el ID de colección y el ID de paleta para la paleta que quieres usar, puedes ingresarlos en los subparámetros collection_id
y palette_id
. Un ID de colección o un ID de paleta pueden ser un código alfanumérico o basarse en el nombre de la colección de colores. Los códigos alfanuméricos se usan para las colecciones nativas de Looker. Son específicos de cada instancia y tienen el siguiente aspecto:
color_application:
collection_id: 1297dk12-86a7-4xe0-8dfc-82de20b3806a
palette_id: 93c8aeb7-3f8a-4ca7-6fee-88c3617516a1
Las colecciones de colores personalizadas usan los ID de colección y paleta según el nombre de la colección de colores, que son portátiles en todas las instancias y tienen el siguiente aspecto:
color_application:
collection_id: blue-tone-collection
palette_id: blue-tone-collection-categorical-0
También puede usar la IU a fin de encontrar los colores, las colecciones o las paletas que desee y generar el LookML para agregarlos a su panel. Navega a un elemento definido por el usuario (como un estilo, un panel o una exploración) y aplica los colores, la colección o la paleta que desees a la visualización de ese contenido mediante la IU. Una vez que hayas hecho eso, puedes seguir los pasos para obtener LookML del panel, copiar el LookML que se generó y pegarlo en la sección color_application
.
groupBars
Determine si la visualización debe mostrar cada barra de registro en su propia fila o si las barras de registro para cada valor de etiqueta deben estar todas en la misma fila. Si configuras groupBars
como true
, todos los registros que comparten el mismo valor de etiqueta aparecen como barras individuales en la misma fila de la visualización.
groupBars: true | false
labelSize
Especifica un tamaño de fuente para las etiquetas. Por ejemplo:
labelSize: 12pt
valueFormat
Especifique el formato de número o de fecha para el valor. El parámetro acepta el formato de estilo Excel. Si no se especifica ningún formato, el valor se mostrará en el formato de la dimensión o medida subyacente.
showLegend
Muestra u oculta una leyenda en la parte inferior de la visualización.
showLegend: true | false