home User Guide Getting Started Help Center Documentation Community Training Certification
menu
close
settings
Looker keyboard_arrow_down
language keyboard_arrow_down
English
Français
Deutsch
日本語
search
print
Table (Legacy) Chart Parameters for LookML Dashboards

The parameters described on this page can be used with LookML dashboard elements of type: table.

For information about building a table (legacy) chart through the Looker UI, see the Table (legacy) Chart Options documentation page.

Example Usage

# BASIC PARAMETERS name: element_name title: 'Element Title' type: looker_table height: N width: N top: N left: N row: N col: N refresh: N (seconds | minutes | hours | days) note: text: 'note text' state: collapsed | expanded display: above | below | hover # QUERY PARAMETERS model: model_name explore: explore_name dimensions: [view_name.field_name, view_name.field_name, …] measures: [view_name.field_name, view_name.field_name, …] sorts: [view_name.field_name asc | desc, view_name.field_name, …] pivots: [view_name.field_name, view_name.field_name, …] limit: N column_limit: N filters: view_name.field_name: 'Looker filter expression' | 'filter value' listen: dashboard_filter_name: dimension_or_measure_name query_timezone: 'specific timezone' | user_timezone merged_queries: - 'primary query definition' - 'next source query definition' join_fields: - field_name: view_name.field_name source_field_name: view_name.field_name # PLOT PARAMETERS table_theme: editable | white | gray | transparent | unstyled total: true | false row_total: right | left | false show_row_numbers: true | false hide_totals: true | false hide_row_totals: true | false hidden_fields: [view_name.field_name, view_name.field_name, …] limit_displayed_rows: true | false limit_displayed_rows_values: show_hide: show | hide first_last: first | last num_rows: 'N' # SERIES PARAMETERS truncate_column_names: true | false show_view_names: true | false series_labels: view_name.field_name: desired series label # FORMATTING PARAMETERS enable_conditional_formatting: true | false conditional_formatting_include_totals: true | false conditional_formatting_include_nulls: true | false conditional_formatting: {'desired conditional formatting'}

Parameter Definitions

Parameter Name Description
Basic Parameters
name (for elements) Creates an element
title (for elements) Changes the way an element name appears to users
type (for elements) Determines the type of visualization to be used in the element
height (for elements) Defines the height of an element in units of tile_size for layout: tile and layout: static dashboards
width (for elements) Defines the width of an element in units of tile_size for layout: tile and layout: static dashboards
top Defines the top-to-bottom position of an element in units of tile_size for layout: static dashboards
left Defines the left-to-right position of an element in units of tile_size for layout: static dashboards
row Defines the top-to-bottom position of an element in units of rows for layout: newspaper dashboards
col Defines the left-to-right position of an element in units of columns for layout: newspaper dashboards
refresh (for elements) Sets the interval at which the element will automatically refresh
note Starts a section of LookML to define a note for an element. This parameter has subparameters text, state, and display.
Query Parameters
model Defines the model to be used for the element’s query
explore (for elements) Defines the Explore to be used for the element’s query
dimensions Defines the dimensions to be used for the element’s query
measures Defines the measures to be used for the element’s query
sorts Defines the sorts to be used for the element’s query
pivots Defines the dimensions that should be pivoted to be used for the element’s query
limit Defines the row limit to be used for the element’s query
filters (for elements) Defines the filters that cannot be changed for the element’s query
listen Defines the filters that can be changed for the element’s query, if filters (for dashboard) have been created
query_timezone Defines the time zone that should be used when the query is run
merged_queries Defines a merged results query
Plot Parameters
table_theme Applies one of five table coloring options to a table visualization
total Specifies whether column totals are displayed for a table visualization
row_total Specifies whether row totals are displayed for a table visualization
show_row_numbers Sets whether to show a row number at the beginning of each table row
hide_totals Sets whether a table visualization displays column totals
hide_row_totals Sets whether a table visualization displays row totals
hidden_fields Specifies any fields to use in the query but hide in the chart
limit_displayed_rows Shows or hides rows in a visualization based on their position in the results
limit_displayed_rows_values Specifies which rows to show or hide in a visualization. This parameter has the subparameters show_hide, first_last, and num_rows.
Series Parameters
truncate_column_names Shortens column headers with an ellipsis (…)
show_view_names Shows the view name along with the field name for each column header
series_labels Specifies a custom label for each column in the visualization
Formatting Parameters
enable_conditional_formatting Sets to true to define color coding rules for a table visualization
conditional_formatting_include_totals Specifies whether totals are included in the color coding scheme
conditional_formatting_include_nulls Specifies whether null values should be represented as a zero
conditional_formatting Uses conditional_formatting and its subparameters to define the rules that color code your table visualization

Basic Parameters

When defining a LookML dashboard element, you must specify values for at least the name and type parameters. Other basic parameters like title, height, and width affect the position and appearance of an element on a dashboard.

name

This section refers to the name parameter that is part of a dashboard element.

name can also be used as part of a dashboard filter, described on the Dashboard Parameters documentation page.

Each name declaration creates a new dashboard element and assigns it a name. Element names must be unique. Names are sometimes referenced in the elements parameter when using layout: grid dashboards.

- name: orders_by_date

title

This section refers to the title parameter that is part of a dashboard element.

title can also be used as part of a dashboard, described on the Dashboard Parameters documentation page.

title can also be used as part of a dashboard filter, described on the Dashboard Parameters documentation page.

The title parameter allows you to change how an element's name will appear to users. If unspecified, the title defaults to the element name.

Consider this example:

- name: sales_overview title: '1) Sales Overview'

If you did this, instead of the element appearing as Sales Overview, it would appear as 1) Sales Overview.

type

This section refers to the type parameter that is part of a dashboard element.

type can also be used as part of a dashboard filter, described on the Dashboard Parameters documentation page.

type can also be used as part of a join, described on the type (for Joins) documentation page.

type can also be used as part of a dimension, described on the Dimension, Filter, and Parameter Types documentation page.

type can also be used as part of a measure, described on the Measure Types documentation page.

The type parameter determines the type of visualization to be used in the element.

- 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_geo_coordinates | looker_geo_choropleth | looker_waterfall | looker_wordcloud | looker_boxplot

See the type (for LookML Dashboards) documentation page for an overview of the different types of LookML dashboard elements.

height

This section refers to the height parameter that is part of a dashboard element.

height can also be used as part of a dashboard row, described on the Dashboard Parameters documentation page.

The height parameter defines the height of an element, in units of tile_size for layout: tile and layout: static dashboards.

For example, the code below specifies tile_size: 100 and height: 4, making the orders_by_date element 400 pixels in height.

- dashboard: sales_overview tile_size: 100 ... elements: - name: orders_by_date height: 4 ...

The height parameter defines the height of an element, in units of rows, for layout: newspaper dashboards.

Each row is 50 pixels tall. A dashboard with newspaper layout defaults to an element height of 6 rows, or 300 pixels.

For example, the code below sets an element to be 600 pixels tall, or twice as tall as other elements that are set to the default:

- dashboard: sales_overview layout: newspaper ... elements: - name: orders_by_date height: 12 ...

width

This section refers to the width parameter that is part of a dashboard element.

width can also be used as part of a dashboard, described on the Dashboard Parameters documentation page.

The width parameter defines the width of an element, in units of tile_size, for layout: tile and layout: static dashboards.

For example, the code below specifies tile_size: 100 and width: 4, making the orders_by_date element 400 pixels in width.

- dashboard: sales_overview tile_size: 100 ... elements: - name: orders_by_date width: 4 ...

The width parameter defines the width of an element, in units of columns, for layout: newspaper dashboards.

A dashboard with newspaper layout defaults to a width of 24 columns.

For example, the code below sets the element to half the width of the dashboard:

- dashboard: sales_overview layout: newspaper ... elements: - name: orders_by_date width: 12 ...

top

The top parameter defines the top-to-bottom position of an element in units of tile_size for layout: static dashboards.

For example, the code below specifies tile_size: 100 and top: 4, positioning the top edge of the orders_by_date element 400 pixels from the top of the dashboard.

- dashboard: sales_overview tile_size: 100 ... elements: - name: orders_by_date top: 4 ...

left

The left parameter defines the left-to-right position of an element in units of tile_size for layout: static dashboards.

For example, the code below specifies tile_size: 100 and left: 4, positioning the left edge of the orders_by_date element 400 pixels from the left side of the dashboard.

- dashboard: sales_overview tile_size: 100 ... elements: - name: orders_by_date left: 4 ...

row

For layout: newspaper dashboards, the row parameter defines the row that the top edge of an element is placed on.

A dashboard begins with row 0 at the very top of the dashboard. A dashboard with newspaper layout defaults to an element height of 6 rows, meaning the dashboard elements at the top of a dashboard (row: 0) would default to taking up rows 0-5.

Each row is 50 pixels tall, which means the default element height of 6 rows is 300 pixels.

For example, the code below sets an element to be set on the second row of elements in the dashboard, assuming elements are set at the default height:

- dashboard: sales_overview layout: newspaper ... elements: - name: orders_by_date row: 6 ...

col

For layout: newspaper dashboards, the col parameter defines the column that the left edge of the element is placed on.

Dashboards are divided into 24 columns. A dashboard begins with column 0 at the very left of the dashboard. A dashboard with newspaper layout defaults to an element width of 8 columns, meaning the dashboard elements at the left of a dashboard (col: 0) would default to taking up columns 0-7.

For example, the code below sets an element to be set in the third column of elements in the dashboard:

- dashboard: sales_overview layout: newspaper ... elements: - name: orders_by_date col: 16 ...

refresh

This section refers to the refresh parameter that is part of a dashboard element.

refresh can also be used as part of a dashboard, described on the Dashboard Parameters documentation page.

The refresh parameter allows an element to reload automatically on some periodic basis, thereby retrieving fresh data. This is often helpful in settings where a dashboard is constantly displayed, such as on an office TV. Note that the dashboard must be open in a browser window for this parameter to have an effect. This setting does not run in the background to "pre-warm" the dashboard cache.

The refresh rate can be any number (without decimals) of seconds, minutes, hours, or days. For example:

- name: orders_by_date refresh: 2 hours

Use caution when setting short refresh intervals. If the query behind the element is resource-intensive, certain elements may strain your database more than desired.

note

You can add descriptive notes to elements like this:

- name: element_name note: text: 'note text' state: collapsed | expanded display: above | below | hover

note has the subparameters text, state, and display.

text

The text subparameter specifies the text displayed in the note. The text can be localized.

state

The state subparameter determines whether the note will be collapsed or expanded if it is too big to fit on a single row within the element's width. If you choose collapsed, and the note is too long, the note will end in a clickable ellipsis (...) that can be used to read the full note.

display

The display subparameter determines where the note is displayed on an element. above places the note at the top of an element, below places it at the bottom of an element, and hover requires the user to hover their mouse over the element in order to see the note.

Query Parameters

When defining a LookML dashboard element, you must specify values for at least the model and explore query parameters, and at least one field must be specified using either the dimensions parameter or the measures parameter. You can also use the other query parameters described below to control the way data is displayed in a dashboard element.

model

The model parameter defines the model to use for the element query. If unspecified, it will default to the model where the dashboard resides.

- name: orders_by_date model: ecommerce

explore

This section refers to the explore parameter that is part of a dashboard element.

explore can also be used as part of a model, described on this documentation page.

explore can also be used as part of a dashboard filter, described on this documentation page.

The explore parameter defines the Explore to use for the element query.

- name: orders_by_date explore: order

dimensions

The dimensions parameter defines the dimension or dimensions to use for the element query. Use the syntax view_name.dimension_name to specify the dimension. Don't include dimensions if the query has no dimensions.

# 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

The measures parameter defines the measure or measures to use for the element query. Use the syntax view_name.measure_name to specify the measure. Don't include measures if the query has no measures.

# single measure example - name: orders_by_date measures: order.count # multiple measure example - name: orders_by_date measures: [order.count, order_item.count]

sorts

The sorts parameter defines the sorts to be used for the element query. The primary sort is listed first, then the secondary sort, and so on. Use the syntax view_name.field_name to specify the dimension or measure. Don't include sorts if you want to use Looker's default sort order. Descending sorts are suffixed with desc; ascending sorts don't need a suffix.

# 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

The pivots parameter defines the dimensions that should be pivoted for the element query. Use the syntax view_name.dimension_name to specify the dimension. Don't include pivots if the query has no pivots.

# single pivot example - name: orders_by_date pivots: customer.gender # multiple pivot example - name: orders_by_date pivots: [customer.gender, customer.age_tier]

limit

The limit parameter defines the row limit that should be used for the element query. The limit applies to the number of rows before any pivots are applied.

- name: orders_by_date limit: 100

filters

This section refers to the filters parameter that is part of a dashboard element.

filters can also be used as part of a dashboard, described on the Dashboard Parameters documentation page.

filters can also be used as part of a measure, described on the filters documentation page.

The filters parameter defines the non-changeable filters that should be used for the element's query. If you would like filters that a user can change in the dashboard, you should set up the filters using filters for dashboards, then apply them to the elements using listen.

The syntax for filters is:

- name: element_name filters: orders.created_date: 2020/01/10 for 3 days orders.status: Shipped # You can create multiple filter statements

Each filter can accept a Looker filter expression or a value constant. You can also use the _localization or _user_attributes Liquid variables in the filter expression for flexible filter values.

listen

Dashboards can have filters that allow users to change the data behind dashboard elements. These are set up by using the filters for dashboards parameter. In order for a filter to impact an element, the element must be set up to "listen" for that filter, using the listen parameter.

The syntax for listen is:

- 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

For example, you might create a filter called Date that requires a user to enter a date into the filter field in the UI. You could then apply the value that the user enters to the orders_by_date element like this:

- dashboard: sales_overview ... filters: - name: date type: date_filter elements: - name: orders_by_date listen: date: order.order_date ...

This concept is described in more detail on the Building LookML Dashboards documentation page.

query_timezone

The query_timezone parameter specifies the time zone in which the query will be run. The time zone options are shown on the Values for timezone documentation page. If you wish the query to run using the viewer's time zone, you can assign the value as user_timezone.

- name: orders_by_date query_timezone: America/Los Angeles
- name: orders_by_customer query_timezone: user_timezone

merged_queries

The merged_queries parameter defines how to merge results from several queries. You define the component queries under the merged_queries parameter and use the join_fields subparameter to define the merge rules.

The syntax for merged_queries is:

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

The first query defined under merged_results is the primary query and the other queries will be merged with that one.

For example, you can merge two queries to return results for company name, company Twitter username, IPO year, stock symbol, number of employees, and job count, by joining on the stock symbol, company name, and Twitter username:

- 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

The data results would be formatted like this:

Then you can apply element parameters to style the visualization as you desire.

Plot Parameters

The below parameters correspond to the options in the Plot section of the visualization editor for table (legacy) charts.

table_theme

Use the table_theme parameter to apply one of the following table coloring options to a table element:

table_theme: editable | white | gray | transparent | unstyled

total

The total parameter sets whether a totals row is shown at the bottom of the table. See Displaying Totals for more information.

total: true | false # default value: false

row_total

The row_total parameter sets whether a totals column is shown on the right or left of the table. Only works if a pivot is present. See Displaying Totals for more information.

row_total: right | left | false # default value: false

show_row_numbers

The show_row_numbers parameter sets whether a row number will be displayed at the beginning of each table row.

show_row_numbers: true | false

hide_totals

If your Explore includes column totals, hide_totals sets whether the visualization displays the totals.

hide_totals: true | false

hide_row_totals

If your Explore includes row totals, hide_row_totals sets whether the row totals will display in the visualization.

hide_row_totals: true | false

hidden_fields

The hidden_fields parameter indicates which fields, if any, are used in the query but hidden in the chart. Any hidden fields will appear in the data table section of an Explore.

hidden_fields: [inventory_items.count, distribution_centers.id]

limit_displayed_rows

The limit_displayed_rows parameter lets you show or hide rows in a visualization, based on their position in the results. For example, if your visualization displays a 7-day rolling average, you may want to hide the first 6 rows. Setting this to true allows you to specify the values and positions in the visualization to which this applies using the limit_displays_rows_values parameter and its subparameters.

limit_displayed_rows: true limit_displayed_rows_values: show_hide: hide | show first_last: first | last num_rows: '10'

limit_displayed_rows_values

Use this parameter and its subparameters show_hide, first_last, and num_rows with limit_displayed_rows to specify which rows to show or hide in a visualization. See limit_displayed_rows above for sample usage.

show_hide

The show_hide subparameter sets whether to hide certain rows from the visualization. Set show_hide to show to display only a limited number of rows in the visualization, and set show_hide to hide to exclude certain rows from the visualization.

first_last

The first_last subparameter sets whether the rows to be hidden or shown will be the first or last rows in the result set. Setting first_last to first shows or hides the first rows, while set first_last to last shows or hides the last rows.

num_rows

The num_rows subparameter sets the number of rows to be hidden or shown. For example, num_rows: '10' will show or hide either the first or last 10 rows of the result set from the visualization.

Series Parameters

The below parameters correspond to the options in the Series section of the visualization editor for table (legacy) charts.

truncate_column_names

The truncate_column_names parameter sets whether column headers should be shortened with ellipses (...).

truncate_column_names: true | false

show_view_names

The show_view_names parameter determines whether view names are displayed in chart labels, such as axis names, column names, and so on.

show_view_names: true | false # default value: true

series_labels

Set the labels of one or more series based on the series name, using name: label pairs.

For a pivoted chart, the series names are the pivot names.

series_labels: 'Yes': iOS Users 'No': Android Users

For a chart with multiple measures, the series names are the measure field names.

series_labels: inventory_items.count: Inventory orders.count: Orders

Formatting Parameters

The below parameters correspond to the options in the Formatting section of the visualization editor for table (legacy) charts.

enable_conditional_formatting

Setting enable_conditional_formatting to true allows you to define rules that color code your table visualization, either on a scale or by specifying values of interest.

enable_conditional_formatting: true | false

conditional_formatting_include_totals

If enable_conditional_formatting is set to true, conditional_formatting_include_totals specifies whether totals are included in the color coding scheme.

conditional_formatting_include_totals: true | false

conditional_formatting_include_nulls

If enable_conditional_formatting is set to true, conditional_formatting_include_nulls specifies whether null values should be represented as zeroes.

conditional_formatting_include_nulls: true | false

conditional_formatting

With enable_conditional_formatting set to true, use the conditional_formatting parameter to define the rules that color code your table visualization. For each conditional formatting rule, you can specify settings with the following parameters:

The following is an example of a conditional formatting rule:

conditional_formatting: [{type: less than, value: 20, background_color: "#9fdee0", font_color: "#b15928", bold: true, italic: false, strikethrough: false, fields: [order_items.count], color_application: {collection_id: my-custom-colors, palette_id: my-custom-colors-sequential-0}}]

type

The type parameter specifies whether to color code values along a scale or based on a logical condition.

If you are color coding values on a scale, you can set type to along a scale....

If you are color coding values based on a logical condition, you can specify one of the following values for type, along with a value for value:

type: along a scale... | equal to | not equal to | less than | between | not between | 'null' | not null

value

If you are color coding values based on a logical condition other than 'null' or not null, specify the value to which the rule applies. The value parameter takes a single number or, when type is set to between or not between, a set of two numbers.

value: N | [N, N]

background_color

If your color coding is based on a logical condition (type is set to anything other than along a scale...), use the background_color parameter to specify a background color for the values to which your rule applies.

background_color: "#49cec1"

font_color

If your color coding is based on a logical condition (type is set to anything other than along a scale...), use the font_color parameter to specify a font color for the values to which your rule applies.

font_color: "#1f3e5a"

color_application

The color_application parameter and its subparameters collection_id, palette_id, and options can be used to apply a specific color collection and palette to a conditional formatting rule.

You can add colors to a LookML dashboard by collection ID and palette ID, if you have them. You can also use the UI to find the colors you want and generate the LookML to add them to your dashboard. Navigate to a piece of user-defined content (like a Look, a dashboard, or an Explore), and apply the colors you want to that content's visualization using the UI. Once you've done that, you can follow the steps to get dashboard LookML, copy the LookML that was produced, and paste it in the color_application section. For an overview of Looker's predefined color collections, see the Color Collections documentation page.

The options subparameter can be used when you have set type to along a scale.... It has the following child parameters:

bold

When color coding based on a logical condition, set whether to bold the values to which your rule applies.

bold: true | false

italic

When color coding based on a logical condition, set whether to italicize the values to which your rule applies.

italic: true | false

strikethrough

When color coding based on a logical condition, set whether to apply strikethrough formatting to the values for your rule.

strikethrough: true | false

fields

Specify the fields to which your rule should apply. By default, the rule applies to all numeric fields.

fields: [ view_name.field_name ]

Top