Reference for Analytics Dashboards Lightning Web Component

The Lightning web component for CRM Analytics dashboards has attributes that can be set programmatically so you can create, render, and interact with a CRM Analytics dashboard on a page at runtime. A majority of the attributes are present for both the Lightning and Experience Cloud components, but there are a few differences that are noted.

Attributes

Name	Type	Required or Optional	Description
`context`	string	Optional	Specifies the context for the dashboard.
`dashboard`	string	Required if `developer-name` isn’t specified.	Specifies the unique ID of the dashboard. You can get a dashboard’s ID, an 18-character code beginning with `0FK`, from the dashboard’s URL, or you can request it through the API. You can use this attribute instead of `developer-name`, but you can’t include `dashboard` if the name has been set. Either the `developer-name` attribute or the `dashboard` attribute is required.
`dashboard-metadata`	object	Optional	Specifies the metadata for the dashboard.
`developer-name`	string	Required if `dashboard` isn’t specified.	Specifies the unique developer name of the dashboard. You can request the developer name through the API. You can use this attribute instead of `dashboard`, but you can’t include `developer-name` if the ID has been set. Either the `developer-name` attribute or the `dashboard` attribute is required.
`enable-notifications`	boolean	Optional	Indicates whether users can set and manage notifications on widgets (`true`) or not (`false`). The default is `false`.
`enable-subscriptions`	boolean	Optional	Indicates whether users can subscribe to widgets and manage their subscriptions (`true`) or not (`false`). The default is `false`.
`height`	integer	Optional	Specifies the height of the dashboard in pixels. The default is 300.
`hide-on-error`	boolean	Optional	Indicates whether users see a dashboard that has an error (`true`) or not (`false`). When this attribute is set to `true`, if the dashboard has an error it doesn’t appear on the page. When set to `false`, the dashboard appears but doesn’t show any data. An error can occur if a user doesn’t have access to the dashboard or the dashboard is deleted. The default is `false`.
`is-loaded`	boolean	Optional	Indicates whether the dashboard is fully loaded on the page (`true`) or not (`false`). The default is `false`.
`open-location`	string	Optional	Specifies where the dashboard opens if the user chooses to launch the dashboard in its own page.
`page-id`	string	Optional	Specifies the initial dashboard page to show.
`record-id`	string	Optional	Specifies the ID of the current entity in the context of which the dashboard is being shown.
`show-header`	boolean	Optional	Indicates whether the dashboard displays a header bar that includes dashboard information and controls (`true`) or not (`false`). The header bar automatically appears when either `show-sharing` or `show-title` is `true`. The default is `false`.
`show-post-to-slack`	boolean	Optional	Indicates whether the Post to Slack icon appears in the dashboard header (`true`) or not (`false`). This attribute isn’t available for the `wave-community-dashboard` component.
`show-sharing`	boolean	Optional	Indicates whether to show the Share icon for a dashboard (`true`) or not (`false`). If set to `true` and the dashboard is shareable, then the dashboard shows the Share icon. If you choose to show the Share icon in the dashboard, the smallest supported frame size is 800x612 pixels. The default is `false`.
`show-title`	boolean	Optional	Indicates whether to show the dashboard's title above the dashboard (`true`) or not (`false`). The default is `false`.
`state`	string	Optional	Specifies the state of the dashboard including any filters or selections that have been applied. See Filter and Selection Syntax for Embedded Dashboards.
`width`	integer	Optional	Specifies the width of the dashboard in pixels.

Lightning Page Example: Attributes for a CRM Analytics Dashboard Component

<template>
  <wave-wave-dashboard-lwc
    dashboard="0FKxx000000000xxxx"
    height="800"
    show-title="true"
    show-sharing="true"
    show-header="false"
    open-location="OPEN_IN_TAB">
  </wave-wave-dashboard-lwc>
</template>

Experience Cloud Page Example: Attributes for a CRM Analytics Dashboard Component

<template>
  <wave-community-dashboard
    dashboard="0FKxx000000000xxxx"
    community-base-path="/communitySite/s"
    height="600"
    show-title="true"
    show-sharing="true"
    show-header="false"
    open-location="OPEN_IN_TAB">
  </wave-community-dashboard>
</template>