Dashboard component properties

  • Release version: Australia
  • Updated March 12, 2026
  • 3 minutes to read

    • Disable and enable dashboard component runtime user abilities with these properties.

    Field Description
    Tab Sys Id [tabSysId] If you want to display only one tab of an existing dashboard, specify its SysID. Also specify the dashboard in Default dashboard.

    You can select a dashboard statically or dynamically, through a state variable or a script.
    Use default redirections [defaultDrilldowns] When activated, the inline editor adds default pre-configured redirections for when a segment of a data visualization is clicked. To implement a custom drilldown, set this property to false, then add and customize a Dashboard Widget Clicked event handler as described in the Events section.

    Default: true
    Disable the whole header [hideHeader] Viewers do not see the dashboard header, only the content.
    Hide dashboard picker [hideDashboardPicker] When true, hides the dashboard picker on all dashboards in the workspace

    Default: false
    Disable sharing [hideShareButton] Hides the Share button on all dashboards from all users, but applies only to the Dashboards page where this value is set.

    Default: false
    Disable editing [hideEditButton] Hides the Edit button on all dashboards from all users, but applies only to the Dashboards page where this value is set.

    Default: false
    Disable dashboard creation [hideCreateNewButton] Hides the Create New Dashboard option in the 3-dot menu of the Dashboard page. Users can still create dashboards from the Analytics Center or the dashboards library (Dashboard Overview component).

    When false:

    3-dot menu of dashboards when Disable dashboard creation is off.

    When true:

    3-dot menu of dashboard page when Disable dashboard creation is on.

    Default: false
    Use as embedded [useAsEmbedded] Set to true when you, as a developer, want to use the dashboard component inside your page in isolation from the page's URL parameters. Meaning, you want full control over what the dashboard renders, regardless of URL parameters. The Copy URL and Copy URL with filter options are not available on such embedded dashboards.

    Default: false
    Default dashboard [defaultDashboard] Select an existing dashboard to show in this dashboard component. This other dashboard is usually in the Platform Analytics Experience. For that dashboard to be shown, it must include your workspace or experience in the Dashboard Visibility field in its dashboard details, as described in Configure Platform Analytics dashboard details.

    You can select a dashboard statically or dynamically, through a state variable or a script.
    Shareable Filter SysID [filterId] The sysId of the persisted filter set up of a dashboard
    Global filters [globalFilters] Filters for the visualizations within the dashboard. These filters apply to all relevant data visualizations. The format of the value passed to globalFilter is the stringified form of {encodedQueries: 'encoded-queries-string', filters: 'PAR-Filter'}. Both encodedQueries and filters are transformed into PAR filters internally and merged with existing filters in the dashboard.
    Either encodedQueries, filters, or both can be specified. In the following example, equivalent encodedQueries and filters values both filter visualizations that show records from the Incident [incident] table based on a State field value of 1 or 2:
    JSON.stringify({
    encodedQueries: {incident: 'stateIN1,2'},
    parFilters: [{ order: 0, apply_to: ['incident.state'], values: ['1', '2'] }]
})
    Drilldown to Core UI [drilldownToCoreUI] Toggle on for drill down on table data sources to redirect to the Core UI list of table records. When off, drilling down opens a Simple List component of the table records, if the workspace contains a simple list.

    Does not apply to technical dashboards. Data visualizations on technical dashboards have to have their Visualization Clicked event handlers configured for drilldowns.

    Default: off
    Use data broker to fetch data [useDataBroker] When toggled on, the dashboard prefetches static JavaScript, such as dashboard metadata, using a data broker. The Dashboard data broker preset automatically toggles this property on. Without the preset, this property is off by default. For more information, see Configure dashboard data broker.
    Data broker response for the dashboard [data] The response for the data broker when it is used. The Dashboard data broker preset automatically sets a JSON object for this property. You can override this value or set it manually without turning the preset on, if you absolutely need to.