---
schema_version: "1"
id: e59d13e89efc8ddd2d9b05d6e7ee1e989ae9654ded585c6e150c07569342decc
title: Dashboard
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_dashboard.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_dashboard.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 9e2b7cb0bdb431c2ef5b2e9de9c4da72b7a97b1385fe7632eb7d9c7e5fee3b90
description: Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.
---
# Dashboard

Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. For more information, see “Edit Dashboards in Accessibility Mode in Salesforce Classic” in the Salesforce online help.

Redeploying a dashboard with the same fullName as a previously deleted dashboard via Metadata API restores the deleted dashboard instead of creating a new one, even if the dashboard was removed from the Recycle Bin. The restored dashboard keeps its original Id, CreatedDate, and CreatedById.

## Declarative Metadata File Suffix and Directory Location

Dashboards are stored in the dashboards directory of the corresponding package directory. The file name matches the dashboard title and the extension is .dashboard.

## Retrieving Dashboards

You can’t use the wildcard (\*) symbol with dashboards in package.xml. To retrieve the list of dashboards for populating package.xml with explicit names, call listMetadata() and pass in DashboardFolder as the type. Note that DashboardFolder is not returned as a type in describeMetadata(). Dashboard is returned from describeMetadata() with an associated attribute of inFolder set to true. If that attribute is set to true, you can construct the type by using the component name with the word Folder, such as DashboardFolder.

The following example shows folders in package.xml. The names used in package.xml must be developer names, not dashboard titles.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>MyDBFolder/MyDBName</members\>
        <name\>Dashboard</name\>
    </types\>
    <types\>
        <members\>MyDocumentFolder/MyDocumentName</members\>
        <name\>Document</name\>
    </types\>
    <types\>
        <members\>unfiled$public/MarketingProductInquiryResponse</members\>
        <members\>unfiled$public/SalesNewCustomerEmail</members\>
        <name\>EmailTemplate</name\>
    </types\>
    <types\>
        <members\>MyReportFolder/MyReportName</members\>
        <name\>Report</name\>
    </types\>
    <version\>68.0</version\>
</Package\>

## Version

Dashboard components are available in API version 14.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e161">Field</th>

              <th class="featureTableHeader  " id="d325411e164">Field Type</th>

              <th class="featureTableHeader  " id="d325411e167">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_backgroundEnd"><a name="dashboard_backgroundEnd"><!-- --></a>backgroundEndColor</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. A dashboard can have a gradient color change on its
                charts. This field defines the second color for the gradient and
                <span class="keyword parmname">backgroundStartColor</span> defines the first
                color. If you prefer your background to be all one color or do not
                want a gradient color change, select the same color for this field
                and <span class="keyword parmname">backgroundStartColor</span>. The color is in
                hexadecimal format; for example #FF6600.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">backgroundFadeDirection</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartBackgroundDirection (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The direction of the gradient color change, defined by
                the <span class="keyword parmname">backgroundStartColor</span> and
                <span class="keyword parmname">backgroundEndColor</span> fields. The valid values
                are:<a name="ChartBackgroundDirection_values"><!-- --></a>
                <ul class="ul bulletList" id="ChartBackgroundDirection_values">
                  <li class="li"><samp class="codeph nolang">Diagonal</samp></li>

                  <li class="li"><samp class="codeph nolang">LeftToRight</samp></li>

                  <li class="li"><samp class="codeph nolang">TopToBottom</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_backgroundStart"><a name="dashboard_backgroundStart"><!-- --></a>backgroundStartColor</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The starting color for the gradient color change on the
                dashboard's charts. See <span class="keyword parmname">backgroundEndColor</span> for
                more information. The color is in hexadecimal format; for example
                #FF6600.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">chartTheme</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartTheme (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Determines the default theme for all dashboard charts. Replaces
                <span class="keyword parmname">dashboardChartTheme</span> for API v42.0 and
                later.<ul class="ul bulletList"></ul>
                <a name="chartTheme"><!-- --></a>
                <ul class="ul bulletList" id="chartTheme">
                  <li class="li">
                    <samp class="codeph nolang">light</samp>—Light-colored theme.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">dark</samp>—Dark-colored theme.
                  </li>

                </ul>
                <p class="p">This field is available in API version 42.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">colorPalette</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartColorPalettes (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Determines the default palette for all dashboard charts. Replaces
                <span class="keyword parmname">dashboardColorPalette</span> for API v42.0 and later.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">accessible</samp></li>

                  <li class="li"><samp class="codeph nolang">bluegrass</samp></li>

                  <li class="li"><span class="keyword parmname">branding</span></li>

                  <li class="li"><samp class="codeph nolang">colorSafe</samp></li>

                  <li class="li"><samp class="codeph nolang">Default</samp></li>

                  <li class="li"><samp class="codeph nolang">dusk</samp></li>

                  <li class="li"><samp class="codeph nolang">earth</samp></li>

                  <li class="li"><samp class="codeph nolang">fire</samp></li>

                  <li class="li"><samp class="codeph nolang">gray</samp></li>

                  <li class="li"><samp class="codeph nolang">heat</samp></li>

                  <li class="li"><samp class="codeph nolang">justice</samp></li>

                  <li class="li"><samp class="codeph nolang">nightfall</samp></li>

                  <li class="li"><samp class="codeph nolang">pond</samp></li>

                  <li class="li"><samp class="codeph nolang">sunrise</samp></li>

                  <li class="li"><samp class="codeph nolang">tropic</samp></li>

                  <li class="li"><samp class="codeph nolang">unity</samp></li>

                  <li class="li"><samp class="codeph nolang">water</samp></li>

                  <li class="li"><samp class="codeph nolang">watermelon</samp></li>

                </ul>
                <p class="p">This field is available in API version 42.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">dashboardChartTheme</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartTheme (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Determines the default theme for all dashboard charts. <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">light</samp>—Light-colored theme.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">dark</samp>—Dark-colored theme.
                  </li>

                </ul>
                <p class="p">This field is available to maintain backward compatibility
                  with versions prior to API version 42.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">dashboardColorPalette</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">ChartColorPalettes (enumeration of type string)</td>

              <td class="entry" headers="d325411e167" data-title="Description">Determines the default palette for all dashboard charts. <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">accessible</samp></li>

                  <li class="li"><samp class="codeph nolang">bluegrass</samp></li>

                  <li class="li"><samp class="codeph nolang">colorSafe</samp></li>

                  <li class="li"><samp class="codeph nolang">Default</samp></li>

                  <li class="li"><samp class="codeph nolang">dusk</samp></li>

                  <li class="li"><samp class="codeph nolang">earth</samp></li>

                  <li class="li"><samp class="codeph nolang">fire</samp></li>

                  <li class="li"><samp class="codeph nolang">gray</samp></li>

                  <li class="li"><samp class="codeph nolang">heat</samp></li>

                  <li class="li"><samp class="codeph nolang">justice</samp></li>

                  <li class="li"><samp class="codeph nolang">nightfall</samp></li>

                  <li class="li"><samp class="codeph nolang">pond</samp></li>

                  <li class="li"><samp class="codeph nolang">sunrise</samp></li>

                  <li class="li"><samp class="codeph nolang">tropic</samp></li>

                  <li class="li"><samp class="codeph nolang">unity</samp></li>

                  <li class="li"><samp class="codeph nolang">water</samp></li>

                  <li class="li"><samp class="codeph nolang">watermelon</samp></li>

                </ul>
                <p class="p">This field is available to maintain backward compatibility
                  with versions prior to API version 42.0.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="field_dashboardfilter"><a name="field_dashboardfilter"><!-- --></a>dashboardFilters</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">
                <a class="xref" href="#dashboardFilter">DashboardFilter</a>[]
              </td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_dashboardFilter_desc"><a name="dashboard_dashboardFilter_desc"><!-- --></a>The list of filters in a
                  dashboard.</span>
                <p class="p">This field is available in API version 23.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_dashboardGridLayout"><a name="dashboard_dashboardGridLayout"><!-- --></a>dashboardGridLayout</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><a class="xref" href="#dashboardGridLayout">DashboardGridLayout</a></td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_dashboardGridLayout_desc"><a name="dashboard_dashboardGridLayout_desc"><!-- --></a>Lists the included
                  <a class="xref" href="#dashboardGridComponent">DashboardGridComponent</a> objects, specifies the number
                  of dashboard columns, and sets each dashboard row’s height in
                  pixels.</span>
                <p class="p">This field is available in API version 35.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_dashboardType"><a name="dashboard_dashboardType"><!-- --></a>dashboardType</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><span class="ph" id="DashboardType"><a name="DashboardType"><!-- --></a>DashboardType (enumeration of type
                  string)</span></td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_dashboardType_desc"><a name="dashboard_dashboardType_desc"><!-- --></a>Determines the way
                  visibility settings are set for a dashboard.</span> The valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">SpecifiedUser</samp>—All users see data at the
                    access level of one specific running user, specified in the
                    <span class="keyword parmname">runningUser</span> field, regardless of
                    their own security settings.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LoggedInUser</samp>—Each logged-in user sees data
                    according to his or her own access level.
                  </li>

                  <li class="li">
                    <span class="ph" id="MyTeamUserEnum"><a name="MyTeamUserEnum"><!-- --></a><samp class="codeph nolang">MyTeamUser</samp>—Managers can choose to
                      view the dashboard from the point of view of their
                      subordinates in the role hierarchy.</span> This value is
                    available in API version 20.0 and later.
                  </li>

                </ul>
                <p class="p">This field is available in API version 19.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">description</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Description for the dashboard. Maximum of 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_folderName"><a name="dashboard_folderName"><!-- --></a>folderName</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_folderName_desc"><a name="dashboard_folderName_desc"><!-- --></a>Name of the folder that houses
                  the dashboard.</span>
                <p class="p">This field is available in API version
                  35.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Inherited from <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a>, this field is defined in the WSDL for this
                metadata type. It must be specified when creating, updating, or
                deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm" title="Adds one or more new metadata components to your organization synchronously."><samp class="codeph java">createMetadata()</samp></a>
                to see an example of this field specified for a call.<p class="p">This field
                  specifies the folder and dashboard title; for example
                  <span class="ph filepath">folderSales/California</span>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="dashboard_isGridLayout"><a name="dashboard_isGridLayout"><!-- --></a>isGridLayout</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="dashboard_isGridLayout_desc"><a name="dashboard_isGridLayout_desc"><!-- --></a>Specifies whether a
                  dashboard uses the Lightning Experience layout (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</span>
                <p class="p">Lightning
                  Experience allows dashboards with more than three columns with
                  components that span multiple columns and multiple rows in
                  size.</p>
                <p class="p">This field is available in API version 35.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">dashboardResultRefreshedDate</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. Date that the dashboard was last refreshed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">dashboardResultRunningUser</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. User currently accessing the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">leftSection</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><a class="xref" href="#dashboardComponentSection">DashboardComponentSection</a></td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The left section or column of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">middleSection</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><a class="xref" href="#dashboardComponentSection">DashboardComponentSection</a></td>

              <td class="entry" headers="d325411e167" data-title="Description">The middle section or column of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">numSubscriptions</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e167" data-title="Description">Number of subscriptions reported on the dashboard. This field is
                available in API version 42.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">owner</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">The creator of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">rightSection</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type"><a class="xref" href="#dashboardComponentSection">DashboardComponentSection</a></td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The right section or column of the dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname" id="field_runningUser"><a name="field_runningUser"><!-- --></a>runningUser</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">
                <span class="ph" id="field_runningUser_desc"><a name="field_runningUser_desc"><!-- --></a>The username of the user whose
                  role and sharing settings are used to determine the data shown
                  in the dashboard.</span>
                <p class="p"><span class="ph" id="runningUser_auto_pop"><a name="runningUser_auto_pop"><!-- --></a>When you deploy a dashboard and the
                    value in this field is not defined or does not correspond to
                    a valid user, the field is populated with the username of
                    the user performing the deployment.</span></p>
                <p class="p"><span class="ph" id="runningUser_visibility"><a name="runningUser_visibility"><!-- --></a>Regardless of their security
                    settings, all users viewing a dashboard see exactly the same
                    data, because dashboards are always run using the security
                    settings of a particular user.</span></p>
                <div class="box message confirm">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_tip.png" alt="Tip">
                        <div class="mediaBd">
                          <h4 class="mbs">Tip</h4>
                          <p>To
                            avoid inappropriate exposure of sensitive data, save the
                            dashboard to a folder that is visible only to appropriate
                            users.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">textColor</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. Color of the text on each chart in the dashboard. The
                color is in hexadecimal format; for example #FF6600.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">title</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. The dashboard title.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">titleColor</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. Color of the titles on each dashboard component. The
                color is in hexadecimal format; for example #FF6600.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e161" data-title="Field"><span class="keyword parmname">titleSize</span></td>

              <td class="entry" headers="d325411e164" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e167" data-title="Description">Required. Size of characters in title text. For example, a value
                of 12 indicates 12pt text.</td>

            </tr>

          </tbody>

        </table>

## DashboardFilter

DashboardFilter represents a filter in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| dashboardFilterOptions | [DashboardFilterOption](#dashboardFilterOption)\[\] | The list of items you can select in the **Filter Options** section of the Add Filter dialog. |
| name | string | Required. The filter label. |

## DashboardFilterOption

DashboardFilterOption represents a filter option in a dashboard.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e925">Field</th>

              <th class="featureTableHeader  " id="d325411e928">Field Type</th>

              <th class="featureTableHeader  " id="d325411e931">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e925" data-title="Field"><span class="keyword parmname" id="DashboardFilterOptionOperator"><a name="DashboardFilterOptionOperator"><!-- --></a>operator</span></td>

              <td class="entry" headers="d325411e928" data-title="Field Type">DashboardFilterOperation <p class="p">(enumeration of type
                  string)</p>
              </td>

              <td class="entry" headers="d325411e931" data-title="Description">Required. Represents the filter operation for this filter item.
                Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph soql">equals</samp></li>

                  <li class="li"><samp class="codeph soql">notEqual</samp></li>

                  <li class="li"><samp class="codeph soql">lessThan</samp></li>

                  <li class="li"><samp class="codeph soql">greaterThan</samp></li>

                  <li class="li"><samp class="codeph soql">lessOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">greaterOrEqual</samp></li>

                  <li class="li"><samp class="codeph soql">contains</samp></li>

                  <li class="li"><samp class="codeph soql">notContain</samp></li>

                  <li class="li"><samp class="codeph soql">startsWith</samp></li>

                  <li class="li"><samp class="codeph soql">includes</samp></li>

                  <li class="li"><samp class="codeph soql">excludes</samp></li>

                  <li class="li">
                    <samp class="codeph soql">between</samp>
                    <div class="p">
                      <div class="box message info">
                        <div class="inner">
                          <div class="bd">
                            <div class="media">
                              <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png" alt="Note">
                              <div class="mediaBd">
                                <h4 class="mbs">Note</h4>
                                <p>The “between” operator takes two
                                  operands (for example, “between MinimumValue,
                                  MaximumValue”). Note also that the minimum
                                  value is inclusive, while the maximum value is
                                  exclusive. All other dashboard filter operations
                                  take a single operand only.</p>
                              </div>
                            </div>
                          </div>
                        </div>
                      </div>

                    </div>
                  </li>

                </ul>
                This field is available in API version 24.0 and later. <p class="p">With
                  API version 23.0, valid values are enumerated in <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/customfield.htm" title="Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard, custom, and external objects or standard field definitions on standard objects.">CustomField</a>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e925" data-title="Field"><span class="keyword parmname" id="DashboardFilterOptionValues"><a name="DashboardFilterOptionValues"><!-- --></a>values</span></td>

              <td class="entry" headers="d325411e928" data-title="Field Type">string[]</td>

              <td class="entry" headers="d325411e931" data-title="Description">Required. One or more values in the <strong class="ph uicontrol">Filter
                  Options</strong> area of the Add Filter dialog. This field is
                available in API version 24.0 and later.</td>

            </tr>

          </tbody>

        </table>

## DashboardGridLayout

Lightning Experience features dashboards with more than three columns and components that span multiple columns and multiple rows in size. DashboardGridLayout lists the included dashboard components, specifies the number of dashboard columns, and sets each dashboard row’s height in pixels.

| Field | Field Type | Description |
| --- | --- | --- |
| dashboardGridComponents | DashboardGridComponent\[\] | List of [DashboardGridComponent](#dashboardGridComponent) objects in the dashboard. |
| numberOfColumns | int | Required. Total number of columns in the dashboard. |
| rowHeight | int | Required. Height of each row in pixels. |

## DashboardGridComponent

Lightning Experience features dashboards with more than three columns and components that span multiple columns and multiple rows in size. DashboardGridComponent specifies location and size of a given dashboard component.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e1145">Field</th>

              <th class="featureTableHeader  " id="d325411e1148">Field Type</th>

              <th class="featureTableHeader  " id="d325411e1151">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">colSpan</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The width of the dashboard component in columns.<p class="p">For
                  example, if <span class="keyword parmname">colSpan</span> is 5, then the
                  dashboard component spans five columns.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">columnIndex</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The left-most column that is occupied by the dashboard
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">dashboardComponent</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type"><a class="xref" href="#DashboardComponent">DashboardComponent</a></td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The dashboard component that is being sized and
                placed.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">rowIndex</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The top-most row that is occupied by the dashboard
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1145" data-title="Field"><span class="keyword parmname">rowSpan</span></td>

              <td class="entry" headers="d325411e1148" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1151" data-title="Description">Required. The height of the dashboard component in rows.</td>

            </tr>

          </tbody>

        </table>

## DashboardComponent

A dashboard consists of a group of different components or elements that display data. Each component can use a custom report or a custom s-control as their data source to display corporate metrics or key performance indicators. You can create several dashboard components and display them all in one dashboard aligned in up to three columns.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e1256">Field</th>

              <th class="featureTableHeader  " id="d325411e1259">Field Type</th>

              <th class="featureTableHeader  " id="d325411e1262">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_chartAxisRange"><a name="component_chartAxisRange"><!-- --></a>chartAxisRange</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">ChartRangeType (enumeration of type string)</td>

              <td class="entry" headers="d325411e1262" data-title="Description">A manual or automatic axis range for bar or line charts. The
                valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">auto</samp></li>

                  <li class="li"><samp class="codeph nolang">manual</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">chartAxisRangeMax</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The maximum axis range to be displayed. This only applies to bar
                and line charts in which the <samp class="codeph nolang">manual</samp> axis range is selected for the
                <span class="keyword parmname">chartAxisRange</span> field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">chartAxisRangeMin</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The minimum axis range to be displayed. This only applies to bar
                and line charts in which the <samp class="codeph nolang">manual</samp> axis range is selected for the
                <span class="keyword parmname">chartAxisRange</span> field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="chart_summary"><a name="chart_summary"><!-- --></a>chartSummary</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm#ChartSummary">ChartSummary</a></td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="chart_summary_description"><a name="chart_summary_description"><!-- --></a>Specifies the summary field
                  for the chart data. Required if
                  <span class="keyword parmname">isAutoSelectFromReport</span> is set to
                  <samp class="codeph nolang">false</samp>.</span>
                <p class="p">This
                  field is available in API version 25.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_type"><a name="component_type"><!-- --></a><span class="ph" id="componentType"><a name="componentType"><!-- --></a>componentType</span></span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">DashboardComponentType (enumeration of type string)</td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="componentTypeDescription1"><a name="componentTypeDescription1"><!-- --></a>Required. Dashboard component
                  type. The valid values are:</span><a name="componentTypeDescription2"><!-- --></a>
                <ul class="ul bulletList" id="componentTypeDescription2">
                  <li class="li"><samp class="codeph nolang">Bar</samp></li>

                  <li class="li"><samp class="codeph nolang">BarGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">BarStacked</samp></li>

                  <li class="li"><samp class="codeph nolang">BarStacked100</samp></li>

                  <li class="li"><samp class="codeph nolang">Column</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnLine</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnLineGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnLineStacked</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnLineStacked100</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnStacked</samp></li>

                  <li class="li"><samp class="codeph nolang">ColumnStacked100</samp></li>

                  <li class="li"><samp class="codeph nolang">Donut</samp></li>

                  <li class="li"><samp class="codeph nolang">FlexTable</samp></li>

                  <li class="li"><samp class="codeph nolang">Funnel</samp></li>

                  <li class="li"><samp class="codeph nolang">Gauge</samp></li>

                  <li class="li"><span class="keyword parmname">Image</span></li>

                  <li class="li"><span class="keyword parmname">LightningWebComponent</span></li>

                  <li class="li"><samp class="codeph nolang">Line</samp></li>

                  <li class="li"><samp class="codeph nolang">LineCumulative</samp></li>

                  <li class="li"><samp class="codeph nolang">LineGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">LineGroupedCumulative</samp></li>

                  <li class="li"><samp class="codeph nolang">Metric</samp></li>

                  <li class="li"><samp class="codeph nolang">Pie</samp></li>

                  <li class="li"><span class="keyword parmname">PulseMetricCard</span></li>

                  <li class="li"><span class="keyword parmname">RichText</span></li>

                  <li class="li"><samp class="codeph nolang">Scatter</samp></li>

                  <li class="li"><samp class="codeph nolang">ScatterGrouped</samp></li>

                  <li class="li"><samp class="codeph nolang">SControl</samp></li>

                  <li class="li"><samp class="codeph nolang">Table</samp></li>

                  <li class="li"><span class="keyword parmname">VisualforcePage</span></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="dashboardComponentContents"><a name="dashboardComponentContents"><!-- --></a>dashboardComponentContents</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardComponentContentsTitle">DashboardComponentContent</a>[]
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description">A list of dashboard component contents.<p class="p">This field is available
                  in API version 58.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="dashboardDynamicValuesField"><a name="dashboardDynamicValuesField"><!-- --></a>dashboardDynamicValues</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardDynamicValueTitle">DashboardDynamicValue</a>[]
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="dashboardDynamicValuesDesc"><a name="dashboardDynamicValuesDesc"><!-- --></a>A list of dashboard dynamic
                  values. </span>
                <p class="p">This field is available in API version 36.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="dashboardFilterColumn"><a name="dashboardFilterColumn"><!-- --></a>dashboardFilterColumns</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardFilterColumnTitle">DashboardFilterColumn</a>[]
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="dashboardFilterColumnDesc"><a name="dashboardFilterColumnDesc"><!-- --></a>A list of dashboard filter
                  columns. Each report-based component must have a dashboard
                  filter column that defines the column that the filter applies
                  to.</span>
                <p class="p">This field is available in API version 23.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="dashboardTableColumnField"><a name="dashboardTableColumnField"><!-- --></a>dashboardTableColumn</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardTableColumn">DashboardTableColumn</a>[]
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description"><span class="ph" id="dashboardTableColumnDesc"><a name="dashboardTableColumnDesc"><!-- --></a>Represents a list of columns on
                  a customized dashboard table component.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">displayUnits</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">ChartUnits (enumeration of type string)</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Chart Units. The valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Auto</samp></li>

                  <li class="li"><samp class="codeph nolang">Integer</samp></li>

                  <li class="li"><samp class="codeph nolang">Hundreds</samp></li>

                  <li class="li"><samp class="codeph nolang">Thousands</samp></li>

                  <li class="li"><samp class="codeph nolang">Millions</samp></li>

                  <li class="li"><samp class="codeph nolang">Billions</samp></li>

                  <li class="li"><samp class="codeph nolang">Trillions</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="DrillDownUrl"><a name="DrillDownUrl"><!-- --></a>drillDownUrl</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">For charts, specifies a URL that users go to when they click the
                dashboard component. Use this option to send users to another
                dashboard, report, record detail page, or other system that uses a
                Web interface. This field overrides the
                <span class="keyword parmname">drillEnabled</span> and
                <span class="keyword parmname">drillToDetailEnabled</span> fields.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="DrillEnabled"><a name="DrillEnabled"><!-- --></a>drillEnabled</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="DrillEnabledDesc"><a name="DrillEnabledDesc"><!-- --></a>Specifies whether to take users to the
                  full or filtered source report when they click the dashboard
                  component. Set to <samp class="codeph java">false</samp> to
                  drill to the full source report; set to <samp class="codeph java">true</samp> to drill to the source
                  report filtered by what they clicked. If set to <samp class="codeph java">true</samp>, users can click individual
                  groups, axis values, or legend entries.</span>
                <p class="p">This overrides
                  the <span class="keyword parmname">drillToDetailEnabled</span> field. This field
                  is available in API version 17.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="DrillToDetailEnabled"><a name="DrillToDetailEnabled"><!-- --></a>drillToDetailEnabled</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <span class="ph" id="DrillDetailEnabledDesc"><a name="DrillDetailEnabledDesc"><!-- --></a>When enabled, users are taken to
                  the record detail page when they click a record name, record
                  owner, or feed post in a table or chart. When set to <samp class="codeph java">true</samp> users can click axis and
                  legend values, chart elements, and table entries. The
                  <span class="keyword parmname">drillDownUrl</span> and
                  <span class="keyword parmname">drillEnabled</span> fields override this
                  field.</span> This field is available in API version 20.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="EnableHover"><a name="EnableHover"><!-- --></a>enableHover</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Specifies whether to display values, labels, and percentages when
                hovering over charts. Hover details depend on chart type.
                Percentages apply to pie, donut, and funnel charts only. This field
                is available in API version 17.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="ExpandOthers"><a name="ExpandOthers"><!-- --></a>expandOthers</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Specifies whether to combine all groups less than or equal to 3%
                of the total into a single 'Others' wedge or segment. This only
                applies to pie, donut, and funnel charts. Set to <samp class="codeph java">true</samp> to show all values individually
                on the chart; set to <samp class="codeph java">false</samp> to
                combine small groups into 'Others.' This field is available in API
                version 17.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="flexComponentProperties"><a name="flexComponentProperties"><!-- --></a>flexComponentProperties</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type"><a class="xref" href="#DashboardFlexTableComponent">DashboardFlexTableComponentProperties</a></td>

              <td class="entry" headers="d325411e1262" data-title="Description">Defines metadata for Lightning Experience table columns and
                sorting. This field is available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">footer</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Footer displayed at the bottom of the dashboard component.
                Maximum of 255 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">gaugeMax</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The maximum value on a gauge. A gauge is used to see how far you
                are from reaching a goal. It looks like a speedometer in a
                car.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">gaugeMin</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The minimum value on a gauge.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">groupingColumn</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Specifies the field by which to group data. This data is
                displayed on the X-axis for vertical column charts and on the Y-axis
                for horizontal bar charts.<p class="p"> This field is available in API version
                  25.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">GroupingSortProperties</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type"><a class="xref" href="#DashboardComponentGroupingSortProperties">DashboardComponentGroupingSortProperties</a></td>

              <td class="entry" headers="d325411e1262" data-title="Description">This field captures sort properties of the dashboard component.
                If the component has one or more groupings, sort information is
                stored here; otherwise, it is stored in the <samp class="codeph nolang">sortBy</samp> field. This field is
                available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">header</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Header displayed at the top of the dashboard component. Maximum
                of 80 characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">indicatorBreakpoint1</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The value that separates the
                <span class="keyword parmname">indicatorLowColor</span> from the
                <span class="keyword parmname">indicatorMiddleColor</span> on the
                dashboard.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">indicatorBreakpoint2</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The value that separates the
                <span class="keyword parmname">indicatorMiddleColor</span> from the
                <span class="keyword parmname">indicatorHighColor</span> on the
                dashboard.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_indicatorHighColor"><a name="component_indicatorHighColor"><!-- --></a>indicatorHighColor</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The color representing a high number range on the gauge.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_indicatorLowColor"><a name="component_indicatorLowColor"><!-- --></a>indicatorLowColor</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The color representing a low number range on the gauge.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="component_indicatorMiddleColor"><a name="component_indicatorMiddleColor"><!-- --></a>indicatorMiddleColor</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The color representing a medium number range on the
                gauge.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname"><span class="ph" id="legendPosition"><a name="legendPosition"><!-- --></a>legendPosition</span></span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type"><span class="ph" id="ChartLegendPosition_fieldtype"><a name="ChartLegendPosition_fieldtype"><!-- --></a>ChartLegendPosition
                  (enumeration of type string)</span></td>

              <td class="entry" headers="d325411e1262" data-title="Description">
                <div class="p" id="ChartLegendPosition_description">
                  <a name="ChartLegendPosition_description"><!-- --></a>The location of the legend
                  with respect to the chart. The valid values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">Bottom</samp></li>

                    <li class="li"><samp class="codeph nolang">OnChart</samp></li>

                    <li class="li"><samp class="codeph nolang">Right</samp></li>

                  </ul>
                </div>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">maxValuesDisplayed</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The maximum number of elements to include in the top-level
                grouping of the horizontal axis of a horizontal chart, vertical axis
                of a vertical chart, or selected axis of a stacked bar chart. For
                example, if you want to list only your top five salespeople, create
                an opportunity report that lists total opportunity amounts by owner
                and enter <samp class="codeph nolang">5</samp> in this
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">metricLabel</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Descriptive label for the metric. This is relevant if <samp class="codeph nolang">metric</samp> is the value of the
                <span class="keyword parmname">componentType</span> field.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname"><span class="ph" id="page"><a name="page"><!-- --></a>page</span></span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description"><span class="ph" id="pageDescription"><a name="pageDescription"><!-- --></a>Visualforce page associated with the
                  component.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname"><span class="ph" id="pageHeightInPixels"><a name="pageHeightInPixels"><!-- --></a>pageHeightInPixels</span></span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1262" data-title="Description"><span class="ph" id="pageHeightInPixelsDescription"><a name="pageHeightInPixelsDescription"><!-- --></a>Display height of the
                  Visualforce page in pixels.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">report</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Name of the report associated with the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">scontrol</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">S-control associated with component if <samp class="codeph nolang">scontrol</samp> is the value of the
                <span class="keyword parmname">componentType</span> field. For more information,
                see “Defining Custom S-Controls” in the Salesforce
                online help.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">scontrolHeightInPixels</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Display height of the s-control in pixels.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">showPercentage</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Indicates if percentages are displayed for regions of gauges and
                wedges and segments of pie, donut, and funnel charts (<samp class="codeph java">true</samp>), or not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="showPicturesOnCharts"><a name="showPicturesOnCharts"><!-- --></a>showPicturesOnCharts</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Display Chatter photos for up to 20 records in a horizontal bar
                chart component whose source report is grouped by a user or group
                name field. If there are more than 20 records with photos, record
                names are shown instead of photos. Set <span class="keyword parmname">Grouping
                  Display</span> to <kbd class="ph userinput">None</kbd> to show
                photos. Set the <span class="keyword parmname">Drill Down to</span> option to
                <kbd class="ph userinput">Record Detail Page</kbd> to take users directly
                to user profile or group pages when they click photos. Chatter must
                be enabled for photos to be displayed. Depending on your
                organization's setup, you may not see photos on tables and
                charts.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="showPicturesOnTables"><a name="showPicturesOnTables"><!-- --></a>showPicturesOnTables</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Display Chatter photos for up to 20 records in a horizontal bar
                chart component whose source report is grouped by a user or group
                name field. If there are more than 20 records with photos, record
                names are shown instead of photos. Set <span class="keyword parmname">Grouping
                  Display</span> to <kbd class="ph userinput">None</kbd> to show
                photos. Set the <span class="keyword parmname">Drill Down to</span> option to
                <kbd class="ph userinput">Record Detail Page</kbd> to take users directly
                to user profile or group pages when they click photos. Chatter must
                be enabled for photos to be displayed. Depending on your
                organization's setup, you may not see photos on tables and
                charts.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">showTotal</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Indicates if the total of all wedges is displayed for gauges and
                donut charts (<samp class="codeph java">true</samp>), or not
                (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">showValues</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Indicates if the values of individual records or groups are
                displayed for charts (<samp class="codeph java">true</samp>), or
                not (<samp class="codeph java">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="field_sortBy"><a name="field_sortBy"><!-- --></a>sortBy</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">
                <a class="xref" href="#dashboardComponentFilter">DashboardComponentFilter</a> (enumeration
                of type string)
              </td>

              <td class="entry" headers="d325411e1262" data-title="Description">The sort option for the dashboard component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">sortLegendValues</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description">Specifies whether to sort the legend values for the dashboard
                component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname">title</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e1262" data-title="Description">The title of the dashboard component. Maximum of 40
                characters.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e1256" data-title="Field"><span class="keyword parmname" id="UseReportChart"><a name="UseReportChart"><!-- --></a>useReportChart</span></td>

              <td class="entry" headers="d325411e1259" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e1262" data-title="Description"><span class="ph" id="UseReportChartDesc"><a name="UseReportChartDesc"><!-- --></a>Specifies whether to use the chart
                  defined in the source report on this dashboard component. The
                  chart settings in the source report determine how the chart
                  displays in the dashboard, and any chart settings you define for
                  the dashboard are overridden. If you defined a combination chart
                  in the source report, use this option to use that combination
                  chart on this dashboard.</span></td>

            </tr>

          </tbody>

        </table>

## DashboardComponentContent

dashboardComponentContent represents the content of a dashboard’s components.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e2235">Field</th>

              <th class="featureTableHeader  " id="d325411e2238">Field Type</th>

              <th class="featureTableHeader  " id="d325411e2241">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">additionalInfo</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">Any additional metadata the user wants to include for the
                component contents.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">altText</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The component’s alternative text.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">fileName</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The name of the component file.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">fit</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">Fit (enumeration of type string)</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The image alignment type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">FitHeight</samp></li>

                  <li class="li"><samp class="codeph nolang">FitWidth</samp></li>

                  <li class="li"><samp class="codeph nolang">Original</samp></li>

                  <li class="li"><samp class="codeph nolang">Stretch</samp></li>

                  <li class="li"><samp class="codeph nolang">Tile</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">horizontalAlignment</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">HorizontalAlignment (enumeration of type string)</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The horizontal alignment type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Left</samp></li>

                  <li class="li"><samp class="codeph nolang">Center</samp></li>

                  <li class="li"><samp class="codeph nolang">Right</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">componentParameters</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The parameters for the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">richTextContent</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The rich text content for the component.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">tooltip</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The dashboard component’s tooltip.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2235" data-title="Field"><span class="keyword parmname">verticalAlignment</span></td>

              <td class="entry" headers="d325411e2238" data-title="Field Type">VerticalAlignment (enumeration of type string)</td>

              <td class="entry" headers="d325411e2241" data-title="Description">The vertical alignment type. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Bottom</samp></li>

                  <li class="li"><samp class="codeph nolang">Center</samp></li>

                  <li class="li"><samp class="codeph nolang">Top</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## DashboardDynamicValue

DashboardDynamicValue represents a dynamic value in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| additionalInfo | string | Any additional metadata the user wants to include for the dynamic value. |
| fieldName | string | Required. The name of the field for the dynamic value. |
| isDynamicUser | boolean | Indicates whether the value should be retrieved as the user running the dashboard (true) or not (false). |

## DashboardFilterColumn

DashboardFilterColumn represents a filter column in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| column | string | Required. The report column code for the filter. |

## DashboardTableColumn

DashboardTableColumn represents a column in a customized table component in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| aggregateType | [ReportSummaryType](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm "Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.")\[\] (enumeration of type string) | Specifies the aggregation type for the table column. |
| column | string | Required. The label of the column to use in the table. |
| showTotal | boolean | Displays the totals for each summarizable column in the dashboard table. This field is available in API version 19.0 and later. |
| sortBy | [DashboardComponentSection](#dashboardComponentSection)(enumeration of type string) | The sort option for the dashboard table component. Sort on just one column per table. |

## DashboardFlexTableComponentProperties

DashboardFlexTableComponentProperties represents a column in a customized table component in a dashboard.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e2682">Field</th>

              <th class="featureTableHeader  " id="d325411e2685">Field Type</th>

              <th class="featureTableHeader  " id="d325411e2688">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname">flexTableColumn</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type"><a class="xref" href="#DashboardComponentColumn">DashboardComponentColumn</a></td>

              <td class="entry" headers="d325411e2688" data-title="Description">Represents a column in a Lightning Experience table component.
                This field is available in API version 41.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname">flexTableSortInfo</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type"><a class="xref" href="#DashboardComponentSortInfo">DashboardComponentSortInfo</a></td>

              <td class="entry" headers="d325411e2688" data-title="Description">Represents sorting column and order in a Lightning Experience
                table component. This field is available in API version 41.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname" id="hideChatterPhotos"><a name="hideChatterPhotos"><!-- --></a>hideChatterPhotos</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e2688" data-title="Description">If <samp class="codeph nolang">true</samp>, hides any photos
                from Chatter feeds.<p class="p">This field is available in API version 41.0
                  and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname" id="dashboardComponentDecimalPrecision"><a name="dashboardComponentDecimalPrecision"><!-- --></a>decimalPrecision</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type">integer</td>

              <td class="entry" headers="d325411e2688" data-title="Description">For columns with numeric values, indicates the number of
                significant digits.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2682" data-title="Field"><span class="keyword parmname">useReportTableSetting</span></td>

              <td class="entry" headers="d325411e2685" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e2688" data-title="Description">If <samp class="codeph nolang">true</samp>, users can import report table settings
                to this component. <p class="p">This field is available in API version 65.0
                  and later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## DashboardComponentGroupingSortProperties

DashboardComponentGroupingSortProperties is composed of multiple elements of the type DashboardComponentGroupingSort.

| Field | Field Type | Description |
| --- | --- | --- |
| groupingSorts | [DashboardComponentGroupingSort](#DashboardComponentGroupingSort) | This field stores sort information for a dashboard at each grouping level of granularity. This field is available in API version 46.0 and later. |

## DashboardComponentGroupingSort

DashboardComponentGroupingSort specifies properties for sorting on a dashboard component group.

| Field | Field Type | Description |
| --- | --- | --- |
| groupingLevel | String | Grouping at which this sort configuration is applied. |
| inheritedReportGroupingSort | String | true if the sort order is picked up from an underlying report for this grouping level. |
| sortColumn | String | If grouping is sorted by an aggregate, this value is the aggregate value (such as sortColumn). If the grouping is sorted by its own value, this field is null. |
| sortOrder | String | Ascending or Descending to reflect the sort order. |

## DashboardComponentColumn

DashboardComponentColumn represents a component column in a dashboard. Available in API version 41.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e2956">Field</th>

              <th class="featureTableHeader  " id="d325411e2959">Field Type</th>

              <th class="featureTableHeader  " id="d325411e2962">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">breakPoint1</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The value that separates the <span class="keyword parmname">lowRangeColor</span>
                from the <span class="keyword parmname">midRangeColor</span> on the
                dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">breakPoint2</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The value that separates the <span class="keyword parmname">midRangeColor</span>
                from the <span class="keyword parmname">highRangeColor</span> on the
                dashboard.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">breakPointOrder</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">double</td>

              <td class="entry" headers="d325411e2962" data-title="Description">Conditional highlighting&nbsp;can be applied to multiple columns. This
                field stores the order of conditional highlights.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">highRangeColor</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The color representing a high number range on the&nbsp;column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">lowRangeColor</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The color representing a low number range on the column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">midRangeColor</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">int</td>

              <td class="entry" headers="d325411e2962" data-title="Description">The color representing a mid number range on the column.</td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">reportColumn</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">string</td>

              <td class="entry" headers="d325411e2962" data-title="Description">Required. The report column code for the filter. </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">showTotal</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">boolean</td>

              <td class="entry" headers="d325411e2962" data-title="Description">If <samp class="codeph nolang">true</samp>, the column total is
                displayed. </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e2956" data-title="Field"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d325411e2959" data-title="Field Type">DashboardComponentColumnType (enumeration of type string)</td>

              <td class="entry" headers="d325411e2962" data-title="Description">Represents the type of Lightning Experience table column:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Details</samp></li>

                  <li class="li"><samp class="codeph nolang">Aggregates</samp></li>

                  <li class="li"><samp class="codeph nolang">Grouping</samp></li>

                </ul>
                <p class="p">This field is available in API version 41.0 and
                  later.</p>
              </td>

            </tr>

          </tbody>

        </table>

## DashboardComponentSortInfo

DashboardFilterColumns represents a filter column in a dashboard.

| Field | Field Type | Description |
| --- | --- | --- |
| sortColumn | string | Indicates the column on which the table is sorted. This field is available in API version 41.0 and later. |
| sortOrder | string | Indicates whether column sorting is ascending or descending. This field is available in API version 41.0 and later. |

## DashboardComponentSection

DashboardComponentSection represents one of the sections or columns in a dashboard.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d325411e3209">Field</th>

              <th class="featureTableHeader  " id="d325411e3212">Field Type</th>

              <th class="featureTableHeader  " id="d325411e3215">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d325411e3209" data-title="Field"><span class="keyword parmname">columnSize</span></td>

              <td class="entry" headers="d325411e3212" data-title="Field Type"><span class="ph" id="DashboardComponentSection"><a name="DashboardComponentSection"><!-- --></a>DashboardComponentSize
                  (enumeration of type string)</span></td>

              <td class="entry" headers="d325411e3215" data-title="Description">Required. The size of the column in the dashboard:<ul class="ul bulletList">
                  <li class="li"><span class="keyword parmname">Medium</span></li>

                  <li class="li"><span class="keyword parmname">Narrow</span></li>

                  <li class="li"><span class="keyword parmname">Wide</span></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d325411e3209" data-title="Field"><span class="keyword parmname">components</span></td>

              <td class="entry" headers="d325411e3212" data-title="Field Type">DashboardComponent[]</td>

              <td class="entry" headers="d325411e3215" data-title="Description">The list of <a class="xref" href="#DashboardComponent">DashboardComponent</a> objects in the
                dashboard column.</td>

            </tr>

          </tbody>

        </table>

## DashboardComponentFilter

DashboardComponentFilter is an enumeration of type string that lists the sort values for dashboard components. The valid values are:

| Enumeration Value | Description |
| --- | --- |
| RowLabelAscending | Sorts in alphabetical order by the label. |
| RowLabelDescending | Sorts in reverse alphabetical order by the label. |
| RowValueAscending | Sorts lowest to highest by the value. |
| RowValueDescending | Sorts highest to lowest by the value. |

## Declarative Metadata Sample Definition — Filtered Dashboard

A sample XML definition of a filtered dashboard is shown below. Note that this example is supported in API version 24.0 and later. The file name matches the dashboard title and the extension is .dashboard.

<?xml version="1.0" encoding="UTF-8"?>
<Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">
    <backgroundEndColor\>#FFFFFF</backgroundEndColor\>
    <backgroundFadeDirection\>Diagonal</backgroundFadeDirection\>
    <backgroundStartColor\>#FFFFFF</backgroundStartColor\>
    <dashboardFilters\>
        <dashboardFilterOptions\>
            <operator\>equals</operator\>
            <values\>Media</values\>
        </dashboardFilterOptions\>
        <dashboardFilterOptions\>
            <operator\>lessThan</operator\>
            <values\>Working</values\>
        </dashboardFilterOptions\>
        <dashboardFilterOptions\>
            <operator\>between</operator\>
            <values\>ABC</values\>
            <values\>XYZ</values\>
        </dashboardFilterOptions\>
        <name\>Industry</name\>
    </dashboardFilters\>
    <dashboardFilters\>
        <dashboardFilterOptions\>
            <operator\>equals</operator\>
            <values\>Analyst,Partner</values\>
        </dashboardFilterOptions\>
        <dashboardFilterOptions\>
            <operator\>startsWith</operator\>
            <values\>Integrator</values\>
        </dashboardFilterOptions\>
        <name\>Account Type</name\>
    </dashboardFilters\>
    <dashboardType\>SpecifiedUser</dashboardType\>
    <leftSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Bar</componentType\>
            <dashboardFilterColumns\>
                <column\>INDUSTRY</column\>
            </dashboardFilterColumns\>
            <dashboardFilterColumns\>
                <column\>TYPE</column\>
            </dashboardFilterColumns\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>false</drillEnabled\>
            <drillToDetailEnabled\>false</drillToDetailEnabled\>
            <enableHover\>false</enableHover\>
            <expandOthers\>false</expandOthers\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>unfiled$public/SampleReportofAccounts</report\>
            <showPercentage\>false</showPercentage\>
            <showPicturesOnCharts\>false</showPicturesOnCharts\>
            <showValues\>false</showValues\>
            <sortBy\>RowLabelAscending</sortBy\>
            <useReportChart\>false</useReportChart\>
        </components\>
    </leftSection\>
    <middleSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Funnel</componentType\>
            <dashboardFilterColumns\>
                <column\>ACCOUNT\_INDUSTRY</column\>
            </dashboardFilterColumns\>
            <dashboardFilterColumns\>
                <column\>ACCOUNT.TYPE</column\>
            </dashboardFilterColumns\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>false</drillEnabled\>
            <drillToDetailEnabled\>false</drillToDetailEnabled\>
            <enableHover\>false</enableHover\>
            <expandOthers\>false</expandOthers\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>unfiled$public/SampleReportofCases</report\>
            <showPercentage\>false</showPercentage\>
            <showValues\>true</showValues\>
            <sortBy\>RowLabelAscending</sortBy\>
            <useReportChart\>false</useReportChart\>
        </components\>
    </middleSection\>
    <rightSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Column</componentType\>
            <dashboardFilterColumns\>
                <column\>INDUSTRY</column\>
            </dashboardFilterColumns\>
            <dashboardFilterColumns\>
                <column\>ACCOUNT\_TYPE</column\>
            </dashboardFilterColumns\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>false</drillEnabled\>
            <drillToDetailEnabled\>false</drillToDetailEnabled\>
            <enableHover\>false</enableHover\>
            <expandOthers\>false</expandOthers\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>unfiled$public/SampleReportofOpportunities</report\>
            <showPercentage\>false</showPercentage\>
            <showValues\>false</showValues\>
            <sortBy\>RowLabelAscending</sortBy\>
            <useReportChart\>false</useReportChart\>
        </components\>
    </rightSection\>
    <runningUser\>admin@TESTORGNUM</runningUser\>
    <textColor\>#000000</textColor\>
    <title\>My Dashboard</title\>
    <titleColor\>#000000</titleColor\>
    <titleSize\>12</titleSize\>
</Dashboard\>

## Declarative Metadata Sample Definition — Unfiltered Dashboard

A sample XML definition of a dashboard is shown below. The file name matches the dashboard title and the extension is .dashboard.

<?xml version="1.0" encoding="UTF-8"?>
<Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">
    <backgroundEndColor\>#FFFFFF</backgroundEndColor\>
    <backgroundFadeDirection\>LeftToRight</backgroundFadeDirection\>
    <backgroundStartColor\>#FFFFFF</backgroundStartColor\>
    <description\>Dashboard with all possible chart types</description\>
    <leftSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>BarStacked100</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <componentType\>Table</componentType\>
            <dashboardTableColumn\>
                <column\>CLOSE\_DATE</column\>
                <sortBy\>RowLabelAscending</sortBy\>
            </dashboardTableColumn\>
            <dashboardTableColumn\>
                <aggregateType\>Sum</aggregateType\>
                <column\>AMOUNT</column\>
                <showTotal\>true</showTotal\>
            </dashboardTableColumn\>
            <dashboardTableColumn\>
                <column\>STAGE\_NAME</column\>
            </dashboardTableColumn\>
            <dashboardTableColumn\>
                <column\>PROBABILITY</column\>
                <aggregateType\>Maximum</aggregateType\>
            </dashboardTableColumn\>
            <displayUnits\>Integer</displayUnits\>
            <header\>Opportunities Table</header\>
            <indicatorHighColor\>#54C254</indicatorHighColor\>
            <indicatorLowColor\>#C25454</indicatorLowColor\>
            <indicatorMiddleColor\>#C2C254</indicatorMiddleColor\>
            <maxValuesDisplayed\>10</maxValuesDisplayed\>
            <report\>testFolder/sourceRep</report\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Bar</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Column</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
            <useReportChart\>true</useReportChart\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Funnel</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <expandOthers\>true</expandOthers\>
            <legendPosition\>Bottom</legendPosition\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
    </leftSection\>
    <middleSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>ColumnStacked100</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>ColumnStacked</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>ColumnStacked</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>ColumnGrouped</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Column</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
    </middleSection\>
    <rightSection\>
        <columnSize\>Medium</columnSize\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Bar</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Pie</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <expandOthers\>true</expandOthers\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>LineGroupedCumulative</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>LineGrouped</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>LineCumulative</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
        <components\>
            <chartAxisRange\>Auto</chartAxisRange\>
            <componentType\>Donut</componentType\>
            <displayUnits\>Auto</displayUnits\>
            <drillEnabled\>true</drillEnabled\>
            <enableHover\>true</enableHover\>
            <expandOthers\>true</expandOthers\>
            <report\>testFolder/sourceRep</report\>
            <sortBy\>RowLabelAscending</sortBy\>
        </components\>
    </rightSection\>
    <runningUser\>admin@TESTORGNUM</runningUser\>
    <textColor\>#000000</textColor\>
    <title\>Db Title</title\>
    <titleColor\>#000000</titleColor\>
    <titleSize\>12</titleSize\>
</Dashboard\>

## Declarative Metadata Sample Definition — Lightning Experience Dashboard with isGridLayout Equals true

A sample XML definition of a Lightning Experience dashboard with isGridLayout equals true is shown below. Note that this example is supported in API version 35.0 and later. The file name matches the dashboard title and the extension is .dashboard.

<?xml version="1.0" encoding="UTF-8"?>
<Dashboard xmlns="http://soap.sforce.com/2006/04/metadata">
    <backgroundEndColor\>#FFFFFF</backgroundEndColor\>
    <backgroundFadeDirection\>Diagonal</backgroundFadeDirection\>
    <backgroundStartColor\>#FFFFFF</backgroundStartColor\>
    <dashboardType\>SpecifiedUser</dashboardType\>
    <gridLayout\>
        <dashboardGridComponents\>
            <colSpan\>3</colSpan\>
            <columnIndex\>0</columnIndex\>
            <dashboardComponent\>
                <autoselectColumnsFromReport\>false</autoselectColumnsFromReport\>
                <chartAxisRange\>Auto</chartAxisRange\>
                <chartSummary\>
                    <axisBinding\>y</axisBinding\>
                    <column\>RowCount</column\>
                </chartSummary\>
                <componentType\>Donut</componentType\>
                <drillEnabled\>false</drillEnabled\>
                <drillToDetailEnabled\>false</drillToDetailEnabled\>
                <enableHover\>false</enableHover\>
                <expandOthers\>false</expandOthers\>
                <groupingColumn\>TITLE</groupingColumn\>
                <legendPosition\>Bottom</legendPosition\>
                <report\>unfiled$public/lead\_rpt</report\>
                <showPercentage\>false</showPercentage\>
                <showTotal\>false</showTotal\>
                <showValues\>true</showValues\>
                <sortBy\>RowLabelAscending</sortBy\>
                <useReportChart\>false</useReportChart\>
            </dashboardComponent\>
            <rowIndex\>0</rowIndex\>
            <rowSpan\>3</rowSpan\>
        </dashboardGridComponents\>
        <dashboardGridComponents\>
            <colSpan\>3</colSpan\>
            <columnIndex\>0</columnIndex\>
            <dashboardComponent\>
                <autoselectColumnsFromReport\>false</autoselectColumnsFromReport\>
                <chartAxisRange\>Auto</chartAxisRange\>
                <chartSummary\>
                    <axisBinding\>y</axisBinding\>
                    <column\>RowCount</column\>
                </chartSummary\>
                <componentType\>Pie</componentType\>
                <drillEnabled\>false</drillEnabled\>
                <drillToDetailEnabled\>false</drillToDetailEnabled\>
                <enableHover\>false</enableHover\>
                <expandOthers\>false</expandOthers\>
                <groupingColumn\>TITLE</groupingColumn\>
                <legendPosition\>Bottom</legendPosition\>
                <report\>unfiled$public/lead\_rpt</report\>
                <showPercentage\>false</showPercentage\>
                <showValues\>true</showValues\>
                <sortBy\>RowLabelAscending</sortBy\>
                <useReportChart\>false</useReportChart\>
            </dashboardComponent\>
            <rowIndex\>3</rowIndex\>
            <rowSpan\>3</rowSpan\>
        </dashboardGridComponents\>
        <dashboardGridComponents\>
            <colSpan\>3</colSpan\>
            <columnIndex\>0</columnIndex\>
            <dashboardComponent\>
                <autoselectColumnsFromReport\>false</autoselectColumnsFromReport\>
                <chartAxisRange\>Auto</chartAxisRange\>
                <chartSummary\>
                    <axisBinding\>y</axisBinding\>
                    <column\>RowCount</column\>
                </chartSummary\>
                <componentType\>Column</componentType\>
                <drillEnabled\>false</drillEnabled\>
                <drillToDetailEnabled\>false</drillToDetailEnabled\>
                <enableHover\>false</enableHover\>
                <expandOthers\>false</expandOthers\>
                <groupingColumn\>TITLE</groupingColumn\>
                <legendPosition\>Bottom</legendPosition\>
                <report\>unfiled$public/lead\_rpt</report\>
                <showPercentage\>false</showPercentage\>
                <showValues\>false</showValues\>
                <sortBy\>RowLabelAscending</sortBy\>
                <useReportChart\>false</useReportChart\>
            </dashboardComponent\>
            <rowIndex\>9</rowIndex\>
            <rowSpan\>3</rowSpan\>
        </dashboardGridComponents\>
        <numberOfColumns\>9</numberOfColumns\>
        <rowHeight\>90</rowHeight\>
    </gridLayout\>
    <isGridLayout\>true</isGridLayout\>
    <runningUser\>admin@s1.com</runningUser\>
    <textColor\>#000000</textColor\>
    <title\>sfx</title\>
    <titleColor\>#000000</titleColor\>
    <titleSize\>12</titleSize\>
</Dashboard\>

## Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").

#### See Also

- [Folder](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_folder.htm "Represents a folder. This type extends the Metadata metadata type and inherits its fullName field.")
- [Report](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_report.htm "Represents a custom report. This metadata type only supports custom reports; standard reports aren’t supported.")