User Guide Getting Started Help Center Documentation Community Training
Looker
  
English
Français
Deutsch
日本語
Column Chart Parameters for LookML Dashboards

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

For information about building a column chart through the Looker UI, see the Column Chart Options documentation page.

Example Usage

# BASIC PARAMETERS name: element_name title: 'Element Title' type: looker_column 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' # Possibly more filter statements listen: dashboard_filter_name: dimension_or_measure_name # Possibly more listen statements # PLOT PARAMETERS stacking: normal | percent | '' show_dropoff: true | false ordering: none | asc | desc column_spacing_ratio: number between 0 and 1 column_group_spacing_ratio: number between 0 and 1 hide_legend: true | false legend_position: center | left | right limit_displayed_rows: true | false limit_displayed_rows_values: show_hide: show | hide first_last: first | last num_rows: 'N' # SERIES PARAMETERS colors: [css_color, css_color, …] series_colors: series_name: css_color # Possibly more series color assignments # this still needs to be updated with the updated color info series_labels: 'Series Name': desired series label # Possibly more series label assignments series_types: series_name: column | line | area | scatter # Possibly more series visualization assignments show_view_names: true | false # VALUE PARAMETERS show_value_labels: true | false show_null_labels: true | false label_color: [css_color, css_color, …] font_size: Npx label_rotation: N label_value_format: 'value formatting string' show_totals_labels: true | false hidden_series: [series_name, series_name, …] show_silhouette: true | false totals_color: css_color # X-AXIS PARAMETERS x_axis_scale: auto | ordinal | time x_axis_reversed: true | false show_x_axis_label: true | false x_axis_label: desired x-axis label show_x_axis_ticks: true | false x_axis_gridlines: true | false x_axis_label_rotation: N x_axis_datetime_label: 'time formatting string' # Y-AXIS PARAMETERS y_axis_gridlines: true | false y_axis_reversed: true | false reference_lines: # reference line options

Parameter Definitions

Parameter Name Description
Basic Parameters
name (for elements) Create an element.
title (for elements) Change the way an element name appears to users.
type (for elements) Determine the type of visualization to be used in the element.
height (for elements) Define the height of an element in units of tile_size for layout: tile and layout: static dashboards.
width (for elements) Define the width of an element in units of tile_size for layout: tile and layout: static dashboards.
top Define the top-to-bottom position of an element in units of tile_size for layout: static dashboards.
left Define the left-to-right position of an element in units of tile_size for layout: static dashboards.
refresh (for elements) Set the interval at which the element will automatically refresh.
note Start a section of LookML to define a note for an element. This parameter has subparameters text, state, and display.
Query Parameters
model Define the model to be used for the element’s query.
explore (for elements) Define the Explore to be used for the element’s query.
dimensions Define the dimensions to be used for the element’s query.
measures Define the measures to be used for the element’s query.
sorts Define the sorts to be used for the element’s query.
pivots Define the dimensions that should be pivoted to be used for the element’s query.
limit Define the row limit to be used for the element’s query.
filters (for elements) Define the filters that cannot be changed for the element’s query.
listen Define the filters that can be changed for the element’s query, if filters (for dashboard) have been created.
Plot Parameters
stacking Stack series on top of each other to create a stacked chart.
show_dropoff Add arrows that show the percent change between data points.
ordering Set the order of series values in a stacked or stacked percentage chart.
column_spacing_ratio Set the spacing between columns within a group.
column_group_spacing_ratio Set the spacing between column groups to a value between 0 and 1.
hide_legend Hide the chart legend.
legend_position Specify whether legend appears to the left, center, or right of the chart.
limit_displayed_rows Show or hide rows in a visualization based on their position in the results.
limit_displayed_rows_values Specify which rows to show or hide in a visualization. Has subparameters show_hide, first_last, and num_rows.
Series Parameters
colors Set the colors of chart series based on the order in which the series appear.
series_colors Set the colors of chart series based on the name of the series.
series_labels Change the way a series name appears to users.
series_types Mix visualization types by defining the type for each series.
show_view_names Hide view names from chart labels.
Value Parameters
show_value_labels Show labels next to data points.
show_null_labels Determine if null labels should be shown on a chart when labels are shown.
label_color Specify a comma-separated list of color values.
font_size Set the font size of value labels.
label_rotation With stacking set to the default (''), set the rotation of value labels to a value between -360 and 360.
label_value_format Specify Excel-style formatting for value labels.
show_totals_labels With stacking set to normal, specify whether totals are displayed for each stacked group of data points on a chart.
hidden_series Hide a chart series when the element loads.
show_silhouette With stacking set to normal, display a lightly-shaded representation of a disabled series.
totals_color With stacking set to normal, specify the color of totals labels.
X-Axis Parameters
x_axis_scale Specify how the x-axis scale is calculated.
x_axis_reversed Specify the direction of the x-axis.
show_x_axis_label Hide the x-axis label.
x_axis_label Define a custom x-axis label.
show_x_axis_ticks Show ticks on the x-axis.
x_axis_gridlines Extend grid lines from the x-axis.
x_axis_label_rotation Rotate x-axis labels a number of degrees.
x_axis_datetime_label Specify a format string for the x-axis labels, if they are dates.
Y-Axis Parameters
y_axis_gridlines Extend gridlines from the y-axis.
y_axis_reversed Set the direction of the x-axis.
reference_lines Add reference lines to a chart.

Basic Parameters

When defining a LookML dashboard element, you must specify values for at least the name and type basic parameters. Other basic parameters like title, height, and width affect the appearance and position 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 this 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 this documentation page.

title can also be used as part of a dashboard filter, described on this 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 this documentation page.

type can also be used as part of a join, described on this documentation page.

type can also be used as part of a dimension, described on this documentation page.

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

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

- name: element_name type: text | table | single_value | looker_single_record | looker_column | looker_bar | looker_scatter | looker_line | looker_area | looker_pie | looker_donut_multiples | looker_geo_coordinates | looker_geo_choropleth

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

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

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

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

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

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 this documentation page.

filters can also be used as part of a measure, described on this 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 filter using filters for dashboards, then apply it to the element using listen.

The syntax for filters is:

- name: element_name filters: view_name.dimension_name: 'looker filter expression' # You can add more than one filter statement

Looker filter expressions can be found here. 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.

Plot Parameters

Most of the parameters described in this section correspond to the options in the Plot section of the visualization editor for column charts.

stacking

The stacking parameter specifies how series are clustered visually on a chart.

stacking: normal | percent | '' # default value: ''

show_dropoff

The show_dropoff parameter toggles the appearance of percent change arrows across the chart. For each series, these arrows display the percent of the previous value from left to right.

show_dropoff: true | false # default value: false

ordering

The ordering parameter enables you to order each slice of a stacked or stacked percentage chart by the size of each slice.

column_spacing_ratio

The column_spacing_ratio parameter sets the spacing between columns within a group. This is available for charts that have stacking set to the default grouped setting, specified using '' in LookML. This parameter accepts values between 0 and 1. 0 is associated with minimum spacing between columns within a group, and 1 is associated with maximum spacing between columns within a group.

column_space_ratio: number between 0 and 1

column_group_spacing_ratio

The column_group_spacing_ratio parameter sets the spacing between column groups. This parameter accepts values between 0 and 1. 0 is associated with minimum spacing between column groups, and 1 is associated with maximum spacing between column groups.

column_group_spacing_ratio: number between 0 and 1

hide_legend

This declaration will hide the legend from the visualization.

hide_legend: true | false # default value: false

legend_position

If hide_legend is set to false (and there is more than one series), you can use the legend_position parameter to specify whether the series legend will appear to the left, center, or right of the chart.

legend_position: center | left | right # default value: false

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 exclude certain rows from the visualization, and set show_hide to hide to display only a limited number of rows in 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 parameters described in this section correspond to the options in the Series section of the visualization editor for column charts.

colors

The colors parameter specifies a list of colors for the series. The first color in the list corresponds to the first data series. If there are more series than listed colors, the colors will start over at the beginning.

colors: [blue, orange, yellow, red, purple]

For all chart attributes that specify a color, the color value can take a hex string like #2ca6cd or a CSS named color string like mediumblue.

series_colors

Set the colors of the series based on the series name, using name: value pairs.

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

series_colors: 'Yes': skyblue 'No': '#000000'

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

series_colors: inventory_items.count: crimson orders.count: green

If the series name is not listed in series_colors, the chart will default to the list of colors provided in colors. If colors is not set, the chart will fall back to the default color scheme.

series_labels

Set the label of the 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

series_types

The series_type parameter allows you to use different Cartesian chart types in the same visualization. Use this parameter to assign a chart type to each series that you want to change. The type options are line, column, bar, area, and scatter.

series_types: series_a_name: column series_b_name: line

All series default to the initial chart type that you choose; you can then modify individual series.

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

Value Parameters

The parameters described in this section correspond to the options in the Values section of the visualization editor for column charts.

show_value_labels

Display the value of a bar, line, or point next to the data point.

show_value_labels: true | false # default value: false

show_null_labels

Determine whether labels should be shown for null columns or bars, when show_value_labels is set to true.

show_null_labels: true | false # default value: false

label_color

The label_color parameter accepts a comma-separated list of one or more color values. The color values can be formatted as RGB hex strings, such as #2ca6cd, or as CSS color names, such as mediumblue.

label_color: [blue, green]

font_size

Set the font size of value labels using any valid CSS size, such as 10px or 12px.

font_size: 14px

label_rotation

Set the rotation of the value labels. This parameter accepts values between -360 and 360, denoting the number of degrees to rotate the labels. This parameter is only available when stacking is set to the default ('').

label_rotation: -45

label_value_format

The label_value_format parameter specifies the formatting to apply to a value, independent of any formatting applied to the underlying dimension or measure. The field accepts Excel-style formatting. If label_value_format is not specified, the value will be displayed in the format of the underlying dimension or measure.

You can read about how to specify these formats on the Adding Custom Formatting to Numeric Fields documentation page. However, color formatting is not supported in Looker.

The formatting used in the label_value_format LookML dashboard parameter is the same as formatting used with the value_format LookML parameter, except that the value_format LookML parameter requires the formatting string to be enclosed in double quotes.

label_value_format: '0.00'

show_totals_labels

Set whether totals are displayed for each stacked group of data points on a chart. This parameter is only available when stacking is set to normal.

show_totals_labels: true | false

hidden_series

The hidden_series parameter specifies which series will be hidden in the UI. Users can expose hidden series by clicking them in the chart legend. Consequently, hidden_series may not worked as desired with hide_legend: true.

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

hidden_series: ['Yes', 'No']

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

hidden_series: [inventory_items.count, orders.count]

show_silhouette

When the show_silhouette parameter is set to true and stacking is set to normal, a disabled series will be displayed as a lightly-shaded silhouette.

show_silhouette: true | false

totals_color

This parameter defines the color of the totals labels in a chart. The totals_color parameter is only available when stacking is set to normal.

totals_color: "#2ca6cd"

X-Axis Parameters

The parameters described in this section correspond to the options in the X section of the visualization editor for column charts.

x_axis_scale

This parameter determines how the x-axis scale is calculated.

x_axis_scale: auto | ordinal | time # default value: auto

x_axis_reversed

Set the direction of the x-axis. When x_axis_reversed is set to false, values increase from left to right. When it is set to true, values decrease from left to right.

x_axis_reversed: true | false

show_x_axis_label

This parameter determines whether labels are shown on the x-axis.

show_x_axis_label: true | false # default value: true

x_axis_label

This parameter specifies a label for the x-axis.

x_axis_label: Order Date

show_x_axis_ticks

This parameter determines whether ticks are shown on the x-axis.

show_x_axis_ticks: true | false # default value: true

x_axis_gridlines

This parameter determines whether gridlines are extended from the x-axis.

x_axis_gridlines: true | false # default value: false

x_axis_label_rotation

The x_axis_label_rotation parameter defines the rotation of the x-axis labels in degrees. This parameter accepts values between -360 and 360, denoting the number of degrees to rotate the labels.

x_axis_label_rotation: -45

x_axis_datetime_label

This parameter specifies a format string for the x-axis labels, if they are dates. If x_axis_scale is not set to time, this does nothing.

x_axis_datetime_label: '%b %d'

See the Time Formatting for Charts documentation page for information on formatting times.

Y-Axis Parameters

Under construction: We are working on updating this section of the page. Meanwhile, you can check out the Column Chart Options documentation page to view equivalent visualization menu options for the y-axis.

The parameters described in this section correspond to the options in the Y section of the visualization editor for column charts.

y_axis_gridlines

This parameter determines whether gridlines are extended from the y-axis.

y_axis_gridlines: true | false # default value: true

y_axis_reversed

Set the direction of the y-axis. When y-axis_reversed is set to false, values increase going up the axis. When it is set to true, values decrease going down the axis.

y_axis_reversed: true | false # default value: false

reference_lines

This parameter specifies an array of values for specifying reference lines and regions.

See the Dashboard Reference Line Parameters documentation page for information on setting up reference lines.

reference_lines: # reference line options

Top