This page demonstrates how to add and customize a LookML dashboard element of type: table with LookML dashboard parameters in a dashboard.lkml file.

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

Example usage

Parameter definitions

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 you're using layout: grid dashboards.

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 lets you change how an element's name will appear to users. If unspecified, the title defaults to the element name.

Consider this example:

If you used this format, 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) parameter 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.

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.

For dashboards with tile or static layouts

The height parameter defines the height of an element, in units of tile_size (which is defined in pixels), for layout: tile and layout: static dashboards.

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

For dashboards with newspaper layout

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

A dashboard with newspaper layout defaults to an element height of 6 rows, or about 300 pixels. The minimum height is 1 row for dashboards with a preferred viewer parameter set to dashboards-next. The minimum height is 2 rows for dashboards with a preferred viewer parameter set to dashboards.

For example, the following code sets an element to be 12 rows tall, or twice as tall as other elements that are set to the default:

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 following code specifies tile_size: 100 and width: 4, making the orders_by_date element 400 pixels in width.

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 following code sets the element to half the width of the dashboard:

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 following code 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.

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 following code 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.

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 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 following code sets an element to be set on the second row of elements in the dashboard, assuming elements are set at the default height:

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 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 following code sets an element to be set in the third column of elements in the dashboard:

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:

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:

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 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.

The model parameter accepts LookML constants. You can define a constant in the manifest file for your project, then use the syntax "@{constant_name}" to set the constant as the value for model. Using a constant lets you define the name of a model in one place, which is particularly useful if you're updating the name of a model that is used by multiple dashboard elements.

For more information and an example of using constants with LookML dashboards, see the constant parameter documentation page.

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 the explore parameter documentation page.

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

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

The explore parameter accepts LookML constants. You can define a constant in the manifest file for your project, then use the syntax "@{constant_name}" to set the constant as the value for explore. Using a constant lets you define the name of an Explore in one place, which is particularly useful if you're updating the name of an Explore that is used by multiple dashboard elements.

For more information and an example of using constants with LookML dashboards, see the constant parameter documentation page.

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 doesn't have any.

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 doesn't have any.

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.

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 doesn't have any.

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.

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 parameter 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:

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. 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:

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:

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 want the query to run using the viewer's time zone, you can assign the value as 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:

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

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

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:

• editable: The table has blue dimensions, orange measures, and green table calculations.
• white: The table header is white, the data rows alternate between white and gray, and the text is black.
• gray: The table header is gray, the data rows alternate between white and light gray, and the text is dark gray.
• transparent: The table header is totally transparent, the data rows alternate between totally transparent and translucent gray, and the text color adjusts itself from black to white as needed according to the background color that shows through. Setting table_theme to transparent can be useful when you're using a customized embedded dashboard so that the tile background color shows through the visualization.
• unstyled: The table header and data rows are white, and the text is black.

total

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

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.

show_row_numbers

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

hide_totals

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

hide_row_totals

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

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.

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 lets you 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_values

Use the limit_displayed_rows_values 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 (...).

show_view_names

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

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.

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

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 lets you define rules that color code your table visualization, either on a scale or by specifying values of interest.

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_nulls

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

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:

• type
• value
• background_color
• font_color
• color_application
• bold
• italic
• strikethrough
• fields

The following is an example of a conditional formatting rule:

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:

• equal to: The rule applies to values equal to the number specified for value.
• not equal to: The rule applies to values that are not equal to the number specified for value.
• greater than: The rule applies to values that are greater than the number specified for value.
• less than: The rule applies to values that are less than than the number specified for value.
• between: The rule applies to values that are between the two numbers specified for value.
• not between: The rule applies to values that are not between the two numbers specified for value.
• 'null': The rule applies only to null values.
• not null: The rule applies only to values that are 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.

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.

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.

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:

• steps: This parameter limits the number of colors used to the value given and separates the data into that number of groups. When this parameter is not used, the data is colored according to a gradient covering the entire palette. It accepts values from 2 through 100.
• mirror: When set to true, this parameter applies equal color shifts on either side of the color palette for equal values on either side of a defined center point. It accepts true or false.
• constraints: This parameter sets the data range that conditional formatting applies to and sets a center point to be used for palette application. It accepts the following syntax: constraints: {min: {type: number, value: 3}, max: {type: percentile, value: 99}, mid: {type: average}}
• reverse: This parameter determines whether to reverse the color palette during color application. It accepts true or false.

bold

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

italic

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

strikethrough

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

fields

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