Dashboards can be created in one of two ways. User-defined dashboards are created using the Looker UI, and are described on the [Creating user-defined dashboards](https://docs.cloud.google.com/looker/docs/creating-user-defined-dashboards.md.txt) documentation page. Dashboards can also be [created using LookML](https://docs.cloud.google.com/looker/docs/building-lookml-dashboards.md.txt) and their overall settings modified as discussed on this page.

This page describes the LookML dashboard parameters that affect the entire dashboard.

A LookML dashboard also contains *elements* , which are the data visualizations,
text tiles, buttons, and tile groups on the dashboard. See the
[Dashboard element parameters](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-element.md.txt)
page for links to the reference pages for each individual element type.

## Example usage

    - dashboard: dashboard_name
      title: "chosen dashboard title"
      description: "chosen dashboard description"
      enable_viz_full_screen: true | false
      enabled_dashboard_agents: true | false
      default_dashboard_agent: agent_name
      extends: name_of_dashboard_being_extended
      extension: required
      layout: tile | static | grid | newspaper
      tabs:
      - name: Tab 1
        label: Tab 1
      - name: Tab 2
        label: Tab 2
      - name: Tab 3
        label: Tab 3
      - name: Tab 4
        label: Tab 4
      rows:
        - elements: [element_name, element_name, ...]
          height: N
      tile_size: N
      width: N
      refresh: N (seconds | minutes | hours | days)
      auto_run: true | false

      # DASHBOARD FILTER PARAMETERS
      crossfilter_enabled: true | false
      filters_bar_collapsed: true | false
      filters_location_top: true | false
      filters:
      - name: filter_name
        title: "chosen filter title"
        type: field_filter | number_filter | date_filter
        model: model_name
        explore: explore_name
        field: view_name.field_name
        default_value: Looker filter expression
        allow_multiple_values: true | false
        required: true | false
        vis_filter: true | false
        ui_config:
          type: button_group | checkboxes | range_slider | tag_list | radio_buttons |
                button_toggles | dropdown_menu | slider | day_picker | day_range_picker |
                relative_timeframes | advanced
          display: inline | popover | overflow
          options:
            min: N
            max: N
          - value options
        listens_to_filters:
        - filter_name
          field: view_name.field_name

      # EMBEDDED DASHBOARD PARAMETERS
      embed_style:
        background_color: "css_color"
        show_title: true | false
        title_color: "css_color"
        show_filters_bar: true | false
        tile_background_color: "css_color"
        tile_text_color: "css_color"

      # ELEMENTS PARAMETERS
      elements:
      # One or more element declarations
      tab_name:
      # Optional - for organizing elements onto tabs. Must be declared for each element individually.
      group:
      # Optional - for organizing elements into a tile group. Must be declared for each child element individually.

## Parameter definitions

| Parameter Name | Description |
|---|---|
| [`dashboard`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#dashboard) | Create a dashboard. |
| [`title` (for dashboard)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#title-for-dashboard) | Change the way a dashboard name appears to users. |
| [`description` (for dashboard)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#description-for-dashboard) | Add a description that can be viewed in the [**Dashboard Details** panel](https://docs.cloud.google.com/looker/docs/viewing-dashboards.md.txt#dashboard_details) or in a folder set to [list view](https://docs.cloud.google.com/looker/docs/finding-content.md.txt#list_view). |
| [`enable_viz_full_screen`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#enable_viz_full_screen) | Define whether dashboard viewers can see dashboard tiles in [full-screen and expanded views](https://docs.cloud.google.com/looker/docs/viewing-dashboards.md.txt#view_options). |
| [`enabled_dashboard_agents`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#enabled_dashboard_agents) | Define whether dashboard viewers can chat with the LookML dashboard using a [dashboard agent](https://docs.cloud.google.com/looker/docs/conversational-analytics-looker-data-agents-lookml-dashboards.md.txt). |
| [`default_dashboard_agent`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#default_dashboard_agent) | Specify the default dashboard agent to use for conversational queries on the dashboard. |
| [`extends`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#extends) | Base the LookML dashboard on another LookML dashboard. |
| [`extension`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#extension) | Require that the dashboard is extended by another dashboard. |
| [`layout`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#layout) | Define the way that the dashboard will place elements. |
| [`tabs`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#tabs) | Added 26.4 Adds [dashboard tabs](https://docs.cloud.google.com/looker/docs/tabbed-dashboards.md.txt) to organize elements on a dashboard. Must be used in conjunction with the [`tab_name`](https://docs.cloud.google.com/looker/docs/reference/tab_name) parameter for elements to specify on which tab an element will appear. |
| [`rows`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#rows) | Start a section of LookML to define the elements that should go into each row of a `layout: grid` dashboard. |
| [`elements` (for rows)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#elements-for-rows) | Define the elements that should go into a row of a `layout: grid` dashboard. |
| [`height` (for rows)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#height-for-rows) | Define the height of a row for a `layout: grid` dashboard. |
| [`tile_size`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#tile_size) | Define the size of a tile for a `layout: tile` dashboard. |
| [`width` (for dashboard)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#width-for-dashboard) | Define the width of the dashboard for a `layout: static` dashboard. |
| [`refresh` (for dashboard)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#refresh-for-dashboard) | Set the interval on which dashboard elements will automatically refresh. |
| [`auto_run`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#auto_run) | Determine whether dashboards run automatically when initially opened or reloaded. |
| Filter Parameters ||
| [`crossfilter_enabled`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#crossfilter_enabled) | Enable or disable [cross-filtering](https://docs.cloud.google.com/looker/docs/cross-filtering-dashboards.md.txt) for a dashboard. |
| [`filters_bar_collapsed`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#filters_bar_collapsed) | Set the dashboard filter bar as default [collapsed or expanded](https://docs.cloud.google.com/looker/docs/editing-user-defined-dashboards.md.txt#default_filters_view) for a dashboard. |
| [`filters_location_top`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#filters_location_top) | Set the dashboard filter bar location as [top or right](https://docs.cloud.google.com/looker/docs/editing-user-defined-dashboards.md.txt#filters_location) for a dashboard. |
| [`filters` (for dashboard)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#filters-for-dashboard) | Start a section of LookML to define dashboard filters. |
| [`name` (for filters)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#name-for-filters) | Create a filter. |
| [`title` (for filters)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#title-for-filters) | Change the way a filter name appears to users. |
| [`type` (for filters)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#type-for-filters) | Determine the type of filter to be used. |
| [`default_value`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#default_value) | Set a default value for a filter. |
| [`allow_multiple_values`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#allow_multiple_values) | Limit users to a single filter value. |
| [`required`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#filter_required) | Require that users enter a filter value to run the dashboard. |
| [`ui_config`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#ui_config) | Configure the filter controls that are available when users view a LookML dashboard. Has subparameters [`type`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#type-for-ui_config), [`display`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#display-for-ui_config), and [`options`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config). |
| [`model` (for filters)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#model_for_filters) | (Optional) Specify the model that contains the underlying field of a `type: field_filter` filter. |
| [`explore` (for filters)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#explore-for-filters) | Specify the Explore that contains the underlying field of a `type: field_filter` filter. |
| [`field`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#field) | Specify the underlying field of a `type: field_filter` filter. |
| [`listens_to_filters`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#listens_to_filters) | Narrow suggestions for dashboard filters of [`field_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#field_filter) based on what the user enters for another dashboard filters of `type: field_filter`. |
| [`vis_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#vis_filter) | Configure a filter to appear directly on a visualization tile rather than in the dashboard filter bar. |
| Embedded Dashboard Parameters ||
| [`embed_style`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#embed_style) | Start a section of LookML to define [embedded](https://docs.cloud.google.com/looker/docs/single-sign-on-embedding) dashboard customizations. |
| [`background_color`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#background_color) | Set a background color of an embedded dashboard. |
| [`show_title`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#show_title) | Specify whether the dashboard title is visible on an embedded dashboard. |
| [`title_color`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#title_color) | Set the color of the title of an embedded dashboard. |
| [`show_filters_bar`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#show_filters_bar) | Specify whether the filters bar is visible on an embedded dashboard. |
| [`tile_background_color`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#tile_background_color) | Set the tile background color of an embedded dashboard. |
| [`tile_text_color`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#tile_text_color) | Set the tile text color of an embedded dashboard. |
| Element Parameters ||
| [`elements` (for dashboard)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#elements-for-dashboard) | Start a section of LookML to define dashboard elements. |
| [`group` (for elements)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#group) | Organize dashboard elements into a tile group by specifying the name of a `type: group` element. |

## `dashboard`

The `dashboard` parameter declares a new dashboard and specifies a name for the dashboard. The maximum number of characters is 255; and allowed characters are letters (A-Z), numbers (0-9), dashes (-), and underscores (_). It is typically best practice to place each LookML dashboard in its own LookML file, but it is possible to declare multiple dashboards in a single file.

    - dashboard: sales_overview

To display anything, a dashboard requires at least one element to be added using the [`elements`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#elements-for-dashboard) parameter.

> [!NOTE]
> **Note:** If you change the value of a LookML dashboard's `dashboard` parameter for a dashboard that has been [moved out of the **LookML dashboards** folder](https://docs.cloud.google.com/looker/docs/building-lookml-dashboards.md.txt#moving_lookml_dashboards_outside_of_the_lookml_dashboards_folder), the LookML dashboard will automatically move back into the **LookML dashboards** folder.


## `preferred_viewer` (deprecated)

> [!IMPORTANT]
> **Important:** This parameter is ignored.

Before legacy dashboard deprecation in Looker 23.6, the `preferred_viewer` parameter let you choose the format for viewing and downloading a dashboard as either Looker's default [dashboard experience](https://docs.cloud.google.com/looker/docs/viewing-dashboards.md.txt) or as a legacy dashboard.


## `title` (for dashboard)

> [!NOTE]
>
> **Note:** This section refers to the `title` parameter that is part of a [dashboard](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#dashboard).
>
>
> `title` can also be used as part of a dashboard filter, described on the [`title` (for filters)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#title-for-filters) section on this page.
>
>
> `title` can also be used as part of any dashboard element. A representative example of its usage is provided on the [column chart elements](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#title) documentation page.

The `title` parameter lets you change how a dashboard name will appear to users in [folders](https://docs.cloud.google.com/looker/docs/organizing-spaces.md.txt) and at the top of the dashboard. If not specified, the title defaults to the name of the dashboard. The title text can be [localized](https://docs.cloud.google.com/looker/docs/model-localization.md.txt).

Consider this example:

    - dashboard: sales_overview
      title: "1) Sales Overview"

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


## `description` (for dashboard)

> [!NOTE]
>
> **Note:** This section refers to the `description` parameter that is part of a [dashboard](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#dashboard).
>
>
> `description` can also be used as part of an Explore, as described on the [`description` for Explores parameter](https://docs.cloud.google.com/looker/docs/reference/param-explore-description.md.txt) documentation page.
>
>
> `description` can also be used as part of a field, as described on the [`description` (for fields)](https://docs.cloud.google.com/looker/docs/reference/param-field-description.md.txt) parameter documentation page.

The `description` parameter lets you add a description to a LookML dashboard.

The contents of the `description` parameter will appear in the **Description** field of the [**Dashboard Details** panel](https://docs.cloud.google.com/looker/docs/viewing-dashboards.md.txt#dashboard_details) of a LookML dashboard.

The description is displayed under the dashboard title in the [lists of dashboards](https://docs.cloud.google.com/looker/docs/finding-content.md.txt#navigating_to_dashboards_and_looks_from_folders) when viewed in a folder set to [list view](https://docs.cloud.google.com/looker/docs/finding-content.md.txt#list_view). If a description is not specified, the list displays only the dashboard title.

The description text can be [localized](https://docs.cloud.google.com/looker/docs/model-localization.md.txt).

## `enable_viz_full_screen`

This parameter only takes effect when the [**Full Screen Visualizations** setting](https://docs.cloud.google.com/looker/docs/admin-panel-general-settings.md.txt#full_screen_visualizations) is enabled by a Looker admin. The **Full Screen Visualization** setting is enabled by default.

The `enable_viz_full_screen` parameter lets you set whether dashboard viewers can see dashboard tiles in [full-screen and expanded views](https://docs.cloud.google.com/looker/docs/viewing-dashboards.md.txt#view_options). It is equivalent to the [**Allow full-screen mode for visualizations**](https://docs.cloud.google.com/looker/docs/editing-user-defined-dashboards.md.txt#allow_full-screen_mode_for_visualizations) dashboard setting.

This parameter accepts the values `true` (full-screen and expanded views available) and `false` (full-screen and expanded views not available). The default value is `true`.

## `enabled_dashboard_agents`

The `enabled_dashboard_agents` parameter lets you control whether dashboard viewers can chat with the LookML dashboard using a [dashboard agent](https://docs.cloud.google.com/looker/docs/conversational-analytics-looker-data-agents-lookml-dashboards.md.txt).

This parameter only takes effect when the **Dashboard agents** setting is enabled for your Looker instance on the [**Gemini in Looker** admin page](https://docs.cloud.google.com/looker/docs/admin-panel-platform-gil.md.txt).

This parameter accepts `true` (chat enabled) and `false` (chat disabled). If this parameter is omitted from the LookML dashboard file, it defaults to `true` at the API layer.

    - dashboard: sales_overview
      enabled_dashboard_agents: true

## `default_dashboard_agent`

The `default_dashboard_agent` parameter specifies the name of the [default dashboard agent](https://docs.cloud.google.com/looker/docs/glossary.md.txt#default-agent) to associate with the LookML dashboard. The specified agent must be declared using the [`agent`](https://docs.cloud.google.com/looker/docs/reference/param-agent.md.txt) LookML parameter.

When viewers start a conversation with the dashboard, the default agent's settings, such as thinking mode and the display of debugging information, are applied to the conversation.

    - dashboard: sales_overview
      default_dashboard_agent: sales_overview_agent

If `enabled_dashboard_agents` is `true` and `default_dashboard_agent` is not specified, users can still chat with the dashboard using default settings without custom instructions.

## `extends`

As described on the [Reusing codes with extends](https://docs.cloud.google.com/looker/docs/reusing-code-with-extends.md.txt#extending_a_lookml_dashboard) documentation page, the `extends` parameter lets you base one LookML dashboard on another LookML dashboard, possibly adding or overriding some settings. The `extends` parameter accepts the name of another LookML dashboard.

> [!CAUTION]
> **Caution:** When extending an object, be aware that localization rules apply to your extensions as well. If you are extending an object and then defining new labels or descriptions, you should provide localization definitions in your project's locale strings files. See the [Localizing your LookML model](https://docs.cloud.google.com/looker/docs/model-localization.md.txt#understanding_how_localization_rules_apply_to_extended_objects) documentation page for more information.

## `extension`

As described on the [Reusing code with extends](https://docs.cloud.google.com/looker/docs/reusing-code-with-extends.md.txt#requiring_extension) documentation page, the `extension` parameter indicates that the dashboard *must* be extended by another dashboard. This dashboard is never visible to other users but can be used as a template to create other dashboards that are visible to other users. The `extension` parameter only accepts the value `required`. If the `extension` parameter is not included, extension is not required for the dashboard.

## `layout`

The `layout` parameter sets the layout method that Looker will use when positioning dashboard elements. It accepts the following values:

- **`newspaper`** : Dashboard elements will appear in a 24-column grid. The
  default size for an element is a width of 8 columns and a height of 6 rows.
  Elements are configurable along this grid, specified by the `width`, `height`,
  `row`, and `col`
  [element parameters](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-element.md.txt).
  This layout option is used when
  [a user-defined dashboard is converted to a LookML dashboard](https://docs.cloud.google.com/looker/docs/building-lookml-dashboards.md.txt#creating_a_lookml_copy_of_a_user-defined_dashboard),
  as well as being the default layout when a new LookML dashboard is created
  through the Looker IDE. `newspaper` is the only layout that
  supports [dashboard tabs](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#tabs) and [tile groups](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#group). In addition,
  `newspaper` and `grid` are the only layouts that support
  [conversion from a LookML dashboard to a user-defined dashboard](https://docs.cloud.google.com/looker/docs/converting-lookml-to-user-defined-dashboard.md.txt).

- **`grid`** : Dashboard elements will appear with dynamic widths, which are based on a set of rows that you define with the [`rows`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#rows) parameter and its subparameters [`elements`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#elements-for-rows) and [`height`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#height-for-rows). `newspaper` and `grid` are the only layouts that support [conversion from a LookML dashboard to a user-defined dashboard](https://docs.cloud.google.com/looker/docs/converting-lookml-to-user-defined-dashboard.md.txt).

- **`static`** : Dashboard elements will appear in the order in which they are listed in the LookML file. Each dashboard element must be positioned manually by using the `top` and `left` parameters. These parameters apply to all element types, and details about their usage appear on the [documentation pages](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-element.md.txt) for each individual visualization type. For representative examples of how `top` and `left` work, see the [Column chart parameters for LookML dashboards](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#top) documentation page. `static` does not support [conversion from a LookML dashboard to a user-defined dashboard](https://docs.cloud.google.com/looker/docs/converting-lookml-to-user-defined-dashboard.md.txt).

- **`tile`** : Dashboard elements will appear in the order in which they are listed in the LookML file. The width of the dashboard is dynamic, and is based on the width of the browser. The dashboard elements will dynamically position themselves within the browser to fill the available space. `tile` does not support [conversion from a LookML dashboard to a user-defined dashboard](https://docs.cloud.google.com/looker/docs/converting-lookml-to-user-defined-dashboard.md.txt).

## `tabs`

Adds [tabs](https://docs.cloud.google.com/looker/docs/tabbed-dashboards.md.txt) for organizing elements on dashboards. `tabs` defines the number, names, and labels of tabs that appear on dashboards. Elements are organized on dashboard tabs with the [`tab_name`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#tab_name) parameter.

> [!IMPORTANT]
> **Important:** Tabbed dashboards are supported only for the [`newspaper` dashboard layout method](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#layout).

    - dashboard: sales_overview
      layout: tile
      tabs:
      - name: Tab 1
        label: Tab 1
      - name: Tab 2
        label: Tab 2
      - name: Tab 3
        label: Tab 3
      - name: Tab 4
        label: Tab 4

### `tab_name`

Specifies which dashboard tab that an element will appear on. `tab_name` must be specified for each individual element.

    - dashboard: sales_overview
      layout: tile
      tabs:
      - name: Tab 1
        label: Tab 1
      - name: Tab 2
        label: Tab 2
      - name: Tab 3
        label: Tab 3
      - name: Tab 4
        label: Tab 4
      elements:
      - name: order_count
        type: single_value
        model: ecommerce
        explore: orders
        measures: [orders.count]
        tab_name: Tab 1

## `rows`

For `layout: grid` dashboards, the `rows` parameter starts the section of LookML where you define which elements should go into which rows, as well as the height of each row. Within each row, each element has the same width. If you don't list an element in this section it won't appear on the dashboard.

    - dashboard: sales_overview
      layout: grid
      rows:
        - elements: [element_name, element_name, ...]
          height: 200
        - elements: [element_name, element_name, ...]
          height: 300

### `elements`

The `elements` parameter takes a list of dashboard element names, separated by commas. Each `elements` declaration creates a new row in the dashboard. The elements that are placed into a row will all have the same width. So, if you place 2 elements in a row, they will each take 50% of the available space. If you place 4 elements into a row, they will each take 25% of the available space.

### `height`

The `height` parameter defines the height of a row in pixels. The default value is 300.

## `tile_size`

For `layout: tile` and `layout: static` dashboards, the unit that is used to size and position elements is tile size. You define `tile_size` in pixels, and the default value is 160. For example:

    - dashboard: sales_overview
      layout: tile
      tile_size: 100

In this situation, a dashboard element with `height: 5` and `width: 3` will be 500 pixels high, and 300 pixels wide. The `height` and `width` parameters apply to all element types, and details about their usage appear on the [documentation pages](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-element.md.txt) for each individual visualization type. For a representative example of how `height` and `width` work, see the [Column chart parameters for LookML dashboards](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#height) documentation page.

## `width`

> [!NOTE]
>
> **Note:** This section refers to the `width` parameter that is part of a [dashboard](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#dashboard).
>
>
> `width` can also be used as part of a dashboard element. A representative example of its usage is provided on the documentation page for [column chart elements](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#width).

For `layout: static` dashboards, the `width` parameter defines the total dashboard width that you plan to use in pixels. The `width` parameter will *not* restrict the dashboard to a certain size if you define too large of an element, or too many elements in a row. Rather, the `width` setting helps to keep the dashboard centered on the screen. If you don't set a width, the default is 1200.

    - dashboard: sales_overview
      layout: static
      width: 800

## `refresh`

> [!NOTE]
>
> **Note:** This section refers to the `refresh` parameter that is part of a [dashboard](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#dashboard).
>
>
> `refresh` can also be used as part of a dashboard element. A representative example of its usage is provided on the documentation page for [column chart elements](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#refresh).

The `refresh` parameter allows a dashboard to automatically reload 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:

    - dashboard: sales_overview
      refresh: 2 hours

Use caution when setting short refresh intervals. Since dashboards can contain many queries, some of which may be resource intensive, certain dashboards may strain your database.

## `auto_run`

The `auto_run` parameter determines whether a dashboard will run when it is initially opened or reloaded. The default value is `true`. When this parameter is set to `false`, users will need to press a **Run** button to load the dashboard. For example, a dashboard like this will automatically run when opened:

    - dashboard: sales_overview
      auto_run: true

Regardless of the `auto_run` setting, users must always click a **Run** button after changing filter values. This helps to prevent unwanted reloads when a user pauses during a filter change or wants to change multiple filters at the same time.

## `crossfilter_enabled`

The `crossfilter_enabled` parameter lets you [turn cross-filters on or off](https://docs.cloud.google.com/looker/docs/cross-filtering-dashboards.md.txt#enabling_cross-filtering_for_individual_dashboards) for a dashboard. When this parameter is set to `true`, dashboard viewers can [create cross-filters](https://docs.cloud.google.com/looker/docs/cross-filtering-dashboards.md.txt#creating_cross-filters_on_dashboards) on the dashboard by clicking certain data points.

    - dashboard: sales_data
      crossfilter_enabled: true

## `filters_bar_collapsed`

The `filters_bar_collapsed` parameter lets you set the dashboard filter bar as default [collapsed or expanded](https://docs.cloud.google.com/looker/docs/editing-user-defined-dashboards.md.txt#default_filters_view) for a dashboard. When this parameter is set to `true`, the filter bar is default collapsed. Dashboard viewers can expand the filter bar by clicking the [filters icon](https://docs.cloud.google.com/looker/docs/viewing-dashboards.md.txt#filters_icon). The default for this setting is `false`.

    - dashboard: sales_data
      filters_bar_collapsed: true

## `filters_location_top`

The `filters_location_top` parameter lets you place the dashboard filter bar at the [top or the right](https://docs.cloud.google.com/looker/docs/editing-user-defined-dashboards.md.txt#filters_location) for a dashboard. When this parameter is set to `true`, the filter bar appears at the top of the dashboard; when it is set to `false`, the filter bar appears at the right of the dashboard. The default for this setting is `true`.

    - dashboard: sales_data
      filters_location_top: false

## `filters`

> [!NOTE]
>
> **Note:** This section refers to the `filters` parameter that is part of a [dashboard](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#dashboard).
>
>
> `filters` can also be used as part of a dashboard element. A representative example of its usage is provided on the documentation page for [column chart elements](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#refresh).
>
>
> `filters` can also be used as part of a measure, described on the [`filters`](https://docs.cloud.google.com/looker/docs/reference/param-field-filters.md.txt) parameter documentation page.

The `filters` parameter starts the section of LookML where you define dashboard filters. Filters appear at the top of the dashboard and let users change the data behind dashboard elements.

For a filter to impact an element, the element must be set up to "listen" for
that filter, using the `listen` parameter. This parameter applies to all element
types except [`type: text`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-text-tile.md.txt),
[`type: button`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-button.md.txt), and
[`type: group`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#group). For a representative example of how `listen` works, see
the [Column chart parameters for LookML dashboards](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#listen)
documentation page.

> [!NOTE]
> **Note:** For [dashboard elements that use the `merged_queries` parameter](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#merged_queries), each source query can listen to one or more dashboard filters. Within a merged query definition, you can use the `listen` parameter to define filter logic for each source query independently, regardless of the number of source queries in your merged results element. If a query doesn't have a `listen` parameter, then it won't be affected by any dashboard filters.

When filters are applied to an element in this manner, the filter type must match the dimension or measure type that is listening for the filter (see [Building LookML dashboards](https://docs.cloud.google.com/looker/docs/building-lookml-dashboards.md.txt#filters) for more details).

> [!NOTE]
> **Note:** Don't define two or more filters with the same combination of `name` and `title` in a LookML dashboard. LookML validation doesn't flag this duplicate configuration, and the dashboard will render normally; however, the duplication will cause "copy LookML dashboard" and "import dashboard" operations to fail with an error (for example, \`Failed to copy dashboard\`). If you encounter this issue, review the dashboard's LookML definition to verify that all filter name and title configurations are unique.

Filters have the following form:

    filters:
    - name: filter_name
      title: "chosen filter title"
      type: field_filter | number_filter | date_filter
      model: model_name
      explore: explore_name
      field: view_name.field_name
      default_value: Looker filter expression
      allow_multiple_values: true | false
      required: true | false
      vis_filter: true | false
      listens_to_filters:
      - filter_name
        field: view_name.field_name

### `name`

> [!NOTE]
>
> **Note:** This section refers to the `name` parameter that is part of a [dashboard filter](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#filters-for-dashboard).
>
>
> `name` can also be used as part of a dashboard element. A representative example of its usage is provided on the documentation page for [column chart elements](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#name).

Each `name` declaration creates a new dashboard filter and assigns a name to
it. The name will be referenced in the `listen` parameter of elements that
should be impacted by the filter. The `listen` parameter applies to all element
types besides [`type: text`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-text-tile.md.txt),
[`type: button`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-button.md.txt), and
[`type: group`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#group), and details about its usage appear on the
[documentation pages](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-element.md.txt) for
each individual visualization type. For a representative example of how `listen`
works, see the
[Column chart parameters for LookML dashboards](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#listen)
documentation page.

    filters:
    - name: order_date

### `title` (for filters)

> [!NOTE]
>
> **Note:** This section refers to the `title` parameter that is part of a [dashboard filter](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#filters-for-dashboard).
>
>
> `title` can also be used as part of a dashboard, as described in the [`title` (for dashboard)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#title-for-dashboard) section on this page.
>
>
> `title` can also be used as part of a dashboard element. A representative example of its usage is provided on the [Column chart parameters for LookML dashboards](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#title) documentation page.

The `title` parameter lets you change how a filter name will appear to users at the top of a dashboard. If not specified, the title defaults to the name of the filter.

Consider this example:

    filters:
    - name: order_date
      title: "Order Date(s)"

If you did this, instead of the filter appearing as **Order Date** , it would appear as **Order Date(s)**.

### `type`

> [!NOTE]
>
> **Note:** This section refers to the `type` parameter that is part of a [dashboard filter](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#filters-for-dashboard).
>
>
> `type` can also be used as part of a dashboard element, described on the [`type` (for LookML dashboards)](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-type.md.txt) parameter documentation page.
>
>
> `type` can also be used as part of a join, described on the [`type`](https://docs.cloud.google.com/looker/docs/reference/param-explore-join-type.md.txt) parameter documentation page.
>
>
> `type` can also be used as part of a dimension, described on the [Dimension, filter, and parameter types](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt) documentation page.
>
>
> `type` can also be used as part of a measure, described on the [Measure types](https://docs.cloud.google.com/looker/docs/reference/param-measure-types.md.txt) documentation page.

The `type` parameter specifies the type of input that will be placed in the filter. `type: field_filter` should generally be your default choice, as it connects the filter directly to an underlying dimension or measure and provides a tailored filter widget to the user. The filter types are as follows:

- **[`field_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#field_filter)** : Should generally be your default choice, when you can specify an underlying dimension or measure. Using `type: field_filter` and associating the filter with a `type:string` field causes the filter to suggest possible filter values.
- **[`number_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#number_filter)**: Lets the user input a number, an integer value, or an expression.
- **[`date_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#date_filter)**: Lets the user input a date value or an expression.

- **`string_filter`** (deprecated): The `string_filter` type is no longer supported since the Legacy Dashboard experience was deprecated in Looker 23.6 (see the [Release Notes](https://docs.cloud.google.com/looker/docs/release-notes.md.txt#April_14_2023) for more information). If you want a freeform text input filter without a drop-down list of suggestions, see [the example using `field_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#freeform-text-filter).

#### `field_filter`

Suggests options to choose from, changes its presentation to users based on the underlying field you specify.

This should be your go-to filter type in situations where you want to make suggestions to users as they interact with the filter. The dimension from which suggestions will be pulled is defined by using the [`explore`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#explore-for-filters) and [`field`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#field) parameters, and must be a field of [`type: string`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#string) to generate filter suggestions.

Suggestions may not work if the field comes from a derived table, if [`sql_always_where`](https://docs.cloud.google.com/looker/docs/reference/param-explore-sql-always-where.md.txt) is used on the Explore, or if the field is a measure.

The following is an example of LookML for a `field_filter` type:

    filters:
    - name: order_date
      type: field_filter
      explore: orders
      field: orders.order_date  # must be of the form view_name.dimension_name

If you want a freeform text input filter without a drop-down list of suggestions, use `type: field_filter` and then configure the control type by using `ui_config: type: advanced` (see [UI config](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#ui_config)).

The following example shows a filter that uses freeform text input without suggestions:

    filters:
    - name: customer_name
      type: field_filter
      explore: orders
      field: customer.name
      ui_config:
        type: advanced

#### `number_filter`

Does not make suggestions, lets the user enter an integer or number value or expression.

    filters:
    - name: order_value
      type: number_filter

#### `date_filter`

Does not make suggestions, lets the user enter a date value or expression.

    filters:
    - name: order_date
      type: date_filter

### `default_value`

The `default_value` parameter lets you specify a default value to use for a filter. This value can be helpful to users by suggesting a reasonable starting point.

Make sure to match the default value with the type of filter being used. For example:

    filters:
    - name: order_value
      type: number_filter
      default_value: "50 to 100"

    - name: order_date
      type: date_filter
      default_value: "last 30 days"

    - name: customer_name
      type: field_filter
      explore: orders
      field: customer.name
      default_value: "John Doe"

You can use filter expressions to create default values. The [Looker filter expressions](https://docs.cloud.google.com/looker/docs/filter-expressions.md.txt) documentation page describes this in more detail.

When you use both the `default_value` and the [`ui_config`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#ui_config) parameters, filter expressions must be compatible with the value given to the [`type`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#type_2) subparameter of `ui_config` and the data types that support the `type` value.

You can also use the [`_localization`](https://docs.cloud.google.com/looker/docs/model-localization.md.txt#filter_localization_example) and [`_user_attributes`](https://docs.cloud.google.com/looker/docs/liquid-variable-reference.md.txt#user_attributes) Liquid variables for flexible default filter values.

### `allow_multiple_values`

The `allow_multiple_values` parameter lets you control whether users can select a single filter value or multiple filter values. When this parameter is set to `true` (the default), users can select multiple values for the filter. When this parameter is set to `false`, users are able to select only a single filter value.

For example:

    filters:
    - name: Order ID
      title: Order ID
      type: field_filter
      allow_multiple_values: true
      required: false
      model: thelookstore
      explore: orders
      field: orders.id

### `required`

The `required` parameter lets you require that users provide a value for the filter in order to run the dashboard. By default, filters don't require values. If a filter that does not require a value and is left blank, the data simply isn't restricted by the filter field. If a filter that does require a value and is left blank, the dashboard won't run.

    filters:
      - name: State
        title: State
        type: field_filter
        required: true


### `ui_config`

The `ui_config` subparameter of [`filters`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#filters-for-dashboard) lets you configure filter settings for a LookML dashboard. These settings include the [types](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#type-for-ui_config) of filter controls used, the [placement](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#display-for-ui_config) of filter controls, and [possible filter values](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config).

For example:


      filters:
      - name: City
        title: City
        type: field_filter
        default_value: San Francisco
        allow_multiple_values: true
        required: false
        ui_config:
          type: button_group
          display: inline
          options:
          - San Francisco
          - New York
          - Tokyo
        model: thelook
        explore: order_items
        field: users.city

See the [Adding and editing user-defined dashboard filters](https://docs.cloud.google.com/looker/docs/filters-user-defined-dashboards.md.txt) documentation page for more information about configuring filters with the UI.


#### `type`

The `type` subparameter of `ui_config` lets you specify the [types of filter controls](https://docs.cloud.google.com/looker/docs/filters-user-defined-dashboards.md.txt#dashboard_(beta)_filter_controls) that are shown.

Depending on the value you enter for `type`, filter controls can be single selection or multiple selection.

> [!NOTE]
> **Note:** The values that `type` supports depend on the LookML data [`type`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt) that is assigned to the field that you're filtering on.

|---|---|
| STR = Compatible with the [`string`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#string) data type | DIST = Compatible with the [`distance`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#distance) data type |
| NUM = Compatible with the [`number`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#number) data type and numeric measures | DUR = Compatible with the [`duration`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#duration) data type |
| TIER = Compatible with the [`tier`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#tier) data type | D\&T = Compatible with most [date and time](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#time) data types |
| ZIP = Compatible with the [`zipcode`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#zipcode) data type | LOC = Compatible with the [`location`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#location) data type |
| Y/N = Compatible with the [`yesno`](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#yesno) data type | PAR = Compatible with the [`parameter`](https://docs.cloud.google.com/looker/docs/reference/param-field-parameter.md.txt) parameter |

| Value | Description | Supported Data Types |
|---|---|---|
| Multiple Selection |||
| `button_group` | The filter shows a group of buttons, with one button for each value specified with the [`options`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config) parameter. | STR NUM TIER ZIP Y/N DIST DUR |
| `checkboxes` | The filter shows checkboxes, with one checkbox for each value specified with the [`options`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config) parameter. | STR NUM TIER ZIP Y/N DIST DUR |
| `tag_list` | The filter shows a drop-down listing each possible value specifed using the [`options`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config) parameter. | STR NUM TIER ZIP DIST DUR |
| `range_slider` | For numeric fields, the filter shows a slider that lets users set a range of numbers as the filter's value. The `min` and `max` subparameters of [`options`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config) are used to specify the minimum and maximum possible values for the filter, and the default range can be specified using the [`default_value`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#default_value) parameter. | NUM DIST DUR |
| Single Selection |||
| `button_toggles` | The filter shows a group of buttons, with one button for each value specified with the [`options`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config) parameter. | STR NUM TIER ZIP Y/N DIST DUR PAR |
| `radio_buttons` | The filter displays radio buttons, with a button for **any value** and one button for each value specified with the [`options`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config) parameter. | STR NUM TIER ZIP Y/N DIST DUR PAR |
| `dropdown_menu` | The filter shows a drop-down menu listing each possible value specified using the [`options`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config) parameter. The drop-down also provides users with the option to select **Any value**. | STR NUM TIER ZIP Y/N DIST DUR PAR |
| `slider` | For numeric fields, the filter shows a slider that lets users choose a filter by sliding between the minimum and maximum possible values, which are specified using the [`options`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#options-for-ui_config) parameter. | NUM DIST DUR |
| Dates and Times |||
| `day_picker` | The filter lets users choose a particular date to filter on. | D\&T The single day control can be used with most [timeframes](https://docs.cloud.google.com/looker/docs/reference/param-field-dimension-group.md.txt#timeframe_options) and [time-based types](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#available_time-based_types), but viewers can only select single dates with this type of control. |
| `day_range_picker` | The filter lets users select a start date and an end date to filter on a range of dates. > [!NOTE] > **Note:** When a LookML dashboard is loaded through a browser bookmark, filter controls that are configured with `type: day_range_picker` don't correctly preserve and render URL parameters and filter state (for example, the end date incorrectly shifts by one day in the UI). To resolve this inconsistent display, update the filter's LookML definition by changing the [`ui_config`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#ui_config) type to `advanced`. See the following example: > ``` > ui_config: >   type: advanced >   display: inline > ``` | D\&T The date range control can be used with most [timeframes](https://docs.cloud.google.com/looker/docs/reference/param-field-dimension-group.md.txt#timeframe_options) and [time-based types](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#available_time-based_types), but viewers can select only the date ranges that have this type of control. |
| `date_time_range_input` | The filter lets the user filter on a range of dates and times. | D\&T The date and time range control can be used with most [time-based types](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#available_time-based_types), and viewers must select both date and time options with this type of control. |
| `relative_timeframes` | The filter lets the user filter on a custom range of dates or to choose from timeframe presets such as **Today** , **Last 7 Days** , or **Last 90 Days**. | D\&T The timeframe control can be used with most [timeframes](https://docs.cloud.google.com/looker/docs/reference/param-field-dimension-group.md.txt#timeframe_options) and [time-based types](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#available_time-based_types), but viewers cannot select time options with this type of control. |
| Other |||
| `advanced` | The filter presents options for applying one or more [filters](https://docs.cloud.google.com/looker/docs/filtering-and-limiting.md.txt#basic_filters) or [advanced matches](https://docs.cloud.google.com/looker/docs/filtering-and-limiting.md.txt#advanced_matches_filters) filters. <br /> See the [Using advanced controls](https://docs.cloud.google.com/looker/docs/filters-user-defined-dashboards.md.txt#using_advanced_controls) section on this page to learn more about advanced controls. | STR NUM TIER ZIP Y/N D\&T DIST DUR LOC PAR |


> [!NOTE]
> **Note:** Some [timeframes](https://docs.cloud.google.com/looker/docs/reference/param-field-dimension-group.md.txt#timeframe_options) and [time-based types](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#available_time-based_types) are interpreted as different data types when Looker creates control options for them. Two examples are the [`yesno` timeframe](https://docs.cloud.google.com/looker/docs/reference/param-field-dimension-group.md.txt#yesno), which is interpreted as a [`yesno` data type](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#yesno) and therefore supports the values that are supported by the `yesno` type; and the [`hour_of_day` timeframe](https://docs.cloud.google.com/looker/docs/reference/param-field-dimension-group.md.txt#hour_of_day), which is interpreted as a [`number` data type](https://docs.cloud.google.com/looker/docs/reference/param-dimension-filter-parameter-types.md.txt#number) and therefore supports the values that are supported by the `number` type.

<br />

#### `display`

You can can use the `display` subparameter of `ui_config` to set the position of a dashboard filter. You can position a filter by assigning one of the following values to `display`:

- `inline`: The filter is displayed directly in the top bar of the dashboard.
- `popover`: A summary value appears in the top bar of the dashboard; click the value to see the full filter.
- `overflow`: A **More** button appears in the top bar of the dashboard with a numeric indicator of how many overflow filters there are; users can click the button to see the overflow filters and their values.

Some filter [types](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#type) can only be displayed in certain ways. For example, filters of `type: day_picker` can only be displayed as `inline` or `overflow`. If you give a filter a `display` value that is not valid for that `type`, the filter will display as either `inline` or `popover`, whichever is valid. To learn more, see the [Adding and editing user-defined dashboard filters](https://docs.cloud.google.com/looker/docs/filters-user-defined-dashboards.md.txt#displaying_dashboard_(beta)_filters) documentation page.

For information about positioning dashboard filters using the UI, see the [Adding and editing user-defined filters](https://docs.cloud.google.com/looker/docs/filters-user-defined-dashboards.md.txt#displaying_dashboard_(beta)_filters) documentation page.

#### `options`

The optional `options` subparameter of `ui_config` lets you specify the [values](https://docs.cloud.google.com/looker/docs/filters-user-defined-dashboards.md.txt#values) that a user can choose from to [temporarily update dashboard filter values](https://docs.cloud.google.com/looker/docs/viewing-dashboards.md.txt#temporarily_changing_filter_values_on_dashboards) when users view a LookML dashboard. If you don't specify any values for `options`, Looker pulls the first values from the database.

For example, you can set `San Francisco`, `New York`, and `Tokyo` as the possible values for a filter on the `users.city` field as follows:


    ui_config:
      type: button_group
      display: inline
      options:
      - San Francisco
      - New York
      - Tokyo

If the [`type`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#type-for-ui_config) subparameter of `ui_config` is set to `range_slider` or `slider`, you can use the `min` and `max` subparameters of `options`:

- `min`: Set the minimum possible value for a filter.
- `max`: Set the maximum possible value for a filter.

For example:


    ui_config:
      type: range_slider
      display: inline
      options:
        min: 0
        max: 500

### `model`

For dashboard filters of [`type: field_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#field_filter), the `model` parameter defines the model of the field that you want to use. The `model` parameter is optional and defaults to the model in which the dashboard is included.

    filters:
    - name: State
      title: State
      type: field_filter
      default_value: California
      model: thelookstore
      explore: users
      field: users.state

### `explore`

> [!NOTE]
>
> **Note:** This section refers to the `explore` parameter that is part of a [dashboard filter](https://docs.cloud.google.com/looker/docs/reference/filters-for-dashboard).
>
>
> `explore` can also be used as part of a model, described on the [`explore`](https://docs.cloud.google.com/looker/docs/reference/param-explore-explore.md.txt) parameter documentation page.
>
>
> `explore` can also be used as part of a dashboard element. A representative example of its usage is provided on the documentation page for [column chart elements](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#explore).

For dashboard filters of [`type: field_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#field_filter), you need to define a field from which the filter will pull suggestions. The `explore` parameter specifies which Explore contains the field you want to use.

    filters:
    - name: order_date
      type: field_filter
      explore: orders
      field: orders.order_date

### `field`

For dashboard filters of [`type: field_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#field_filter), you need to define a field from which the filter will pull suggestions. The `field` parameter specifies which field you want to use. It is important to use the fully scoped field name. In other words, use `view_name.field_name`, not just `field_name`.

    filters:
    - name: order_date
      type: field_filter
      explore: orders
      field: orders.order_date

### `listens_to_filters`

For dashboard filters of [`type: field_filter`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#field_filter), you can narrow suggestions for the filter based on what the user enters for another filter of `type: field_filter`.

In the following example, the suggestions provided for the `State` filter will be based on the values from the `Order ID` filter. Whatever values are selected for the `Order ID` filter will have associated `users.state` values, and those values will be suggested values for the `State` filter. See the [Adding and editing user-defined dashboard filters](https://docs.cloud.google.com/looker/docs/filters-user-defined-dashboards.md.txt#setting_up_linked_filters) documentation page for more information.

    filters:
    - name: State
      title: State
      type: field_filter
      model: thelookstore
      explore: users
      listens_to_filters:
      - Order ID
      field: users.state

### `vis_filter`

> [!NOTE]
> **Note:** This feature is in [preview](https://cloud.google.com/products#product-launch-stages).

The `vis_filter` parameter lets you configure a filter as a [visualization-level filter](https://docs.cloud.google.com/looker/docs/filters-user-defined-dashboards.md.txt#filters-on-visualization-tiles) that appears directly on individual visualization tiles rather than in the top dashboard filter bar.

When `vis_filter` is set to `true`, the filter appears in the filter bar at the top of any tile that listens to it (configured using the [`listen`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-column-chart.md.txt#listen) parameter on the dashboard element). The default value is `false`, which displays the filter as a standard dashboard-level filter in the top filter bar. Setting `vis_filter: false` is unnecessary for standard dashboard filters.

For example:

    filters:
    - name: order_date
      title: "Order Date"
      type: date_filter
      default_value: "last 30 days"
      vis_filter: true

For more information about visualization-level filters, see the [Filters on visualization tiles](https://docs.cloud.google.com/looker/docs/filters-user-defined-dashboards.md.txt#filters-on-visualization-tiles) documentation page.

## `embed_style`

The `embed_style` parameter starts the section of LookML where you customize the appearance of an [embedded](https://docs.cloud.google.com/looker/docs/single-sign-on-embedding) dashboard. `embed_style` and its associated parameters are supported only on embedded dashboards and are ignored if the dashboard is not embedded.

After you make changes to `embed_style`, you must [deploy your LookML to production](https://docs.cloud.google.com/looker/docs/version-control-and-deploying-changes.md.txt#deploying_to_production) in order to see your `embed_style` settings reflected in the embedded LookML dashboard.

For the following embedded dashboard attributes that specify a color, the color value can be a hex string like `#2ca6cd` or a [CSS named color string](https://www.w3schools.com/cssref/css_colors.asp) like `mediumblue`.

Embedded dashboard customizations have the following form:

    embed_style:
      background_color: "css_color"
      show_title: true | false
      title_color: "css_color"
      show_filters_bar: true | false
      tile_background_color: "css_color"
      tile_text_color: "css_color"

### `background_color`

Sets the color of the background of an embedded dashboard.

    embed_style:
      background_color: "#ffffff"

### `show_title`

Specifies whether the embedded dashboard title is visible to users.

    embed_style:
      show_title: false

### `title_color`

Sets the color of the title of an embedded dashboard.

    embed_style:
      title_color: "#008000"

### `show_filters_bar`

Specifies whether the embedded dashboard filters are visible to users.

> [!NOTE]
> **Note:** This parameter affects only the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see the [Access control and permission management](https://docs.cloud.google.com/looker/docs/access-control-and-permission-management.md.txt#control_user_access_to_data) documentation page.

    embed_style:
      show_filters_bar: true

### `tile_background_color`

Sets the color of the background of all tiles on an embedded dashboard.

    embed_style:
      tile_background_color: "lightyellow"

### `tile_text_color`

Sets the color of text on all tiles on an embedded dashboard.

    embed_style:
      tile_text_color: "crimson"

## `elements`

> [!NOTE]
>
> **Note:** This section refers to the `elements` parameter that is part of a [`dashboard`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#dashboard).
>
>
> `elements` can also be used as part of a dashboard row, described on the [`elements` for rows](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#elements-for-rows) section on this page.

The `elements` parameter starts the section of LookML where you define the elements that will make up a dashboard. There are many parameters that can define the appearance of a dashboard element. They are described in more detail on the [Dashboard element parameters](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard-element.md.txt) page.

    - dashboard: sales_overview
      layout: tile
      tabs:
      - name: Tab 1
        label: Tab 1
      - name: Tab 2
        label: Tab 2
      - name: Tab 3
        label: Tab 3
      elements:
      - name: order_count
        type: single_value
        model: ecommerce
        explore: orders
        measures: [orders.count]
        tab_name: Tab 1

> [!TIP]
> **Tip:** Think about the number and complexity of elements that you add to a LookML dashboard. More elements require more browser resources, which increases dashboard rendering time. Similarly, elements that render large amounts of data may impact dashboard performance. If rendering becomes an issue, consider reducing the complexity of dashboard element queries or creating multiple dashboards with fewer elements.

### `group`

> [!NOTE]
> **Note:** This feature is in [preview](https://cloud.google.com/products#product-launch-stages).

Organizes dashboard elements into a
[tile group](https://docs.cloud.google.com/looker/docs/editing-user-defined-dashboards.md.txt#organizing_tiles_into_groups)
on a LookML dashboard. To use tile groups on a LookML dashboard, your
Looker admin must enable the
[**Dashboard Tile Groups** preview feature](https://docs.cloud.google.com/looker/docs/admin-panel-general-preview-features.md.txt#dashboard-tile-groups),
and the dashboard must use the [`newspaper` dashboard layout method](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#layout).

To create a tile group and add elements to it in LookML, follow these steps:

1. Define a tile group container in the [`elements`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#elements-for-dashboard) section with `type: group`, and specify its `name`, `title`, `row`, `col`, `width`, and `height` (and, optionally, `tab_name`, `title_hidden`, and `aria_description`). Elements of `type: group` are visual containers and don't accept query parameters such as `model`, `explore`, or `listen`.
2. On each dashboard element that you want to place inside the tile group, add the `group` parameter and set its value to the `name` of the `type: group` element.

When you organize elements into a tile group, keep the following points in mind:

- For elements placed inside a tile group, the `row` and `col` parameters define the element's position relative to the top-left corner (`row: 0`, `col: 0`) of the group container rather than the dashboard canvas.
- On [tabbed dashboards](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#tabs), a child element's [`tab_name`](https://docs.cloud.google.com/looker/docs/reference/param-lookml-dashboard.md.txt#tab_name) must match the parent group's `tab_name`.
- Looker doesn't support nested tile groups (placing a `type: group` element inside another tile group).

    - dashboard: sales_overview
      layout: newspaper
      elements:
      - name: revenue_metrics_group
        title: "Revenue Metrics"
        type: group
        row: 0
        col: 0
        width: 24
        height: 8
      - name: total_revenue
        title: "Total Revenue"
        type: single_value
        model: ecommerce
        explore: orders
        measures: [orders.total_revenue]
        group: revenue_metrics_group
        row: 0
        col: 0
        width: 8
        height: 6