Newer Version Available

This content describes an older version of this product. View Latest

wave:dashboard

Use this component to add a Salesforce Analytics Cloud dashboard to a Visualforce page.

Attributes

Attribute Name Attribute Type Description Required? API Version Access
body Component[] The body of the component. In markup, this is everything in the body of the tag. 34.0 global
dashboardId String 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 in Wave, or you can request it through the API. This attribute can be used instead of the developer name, but it can't be included if the name has been set. One of the two is required. 34.0 global
developerName String The unique developer name of the dashboard. You can request the developer name through the API. This attribute can be used instead of the dashboard ID, but it can't be included if the ID has been set. One of the two is required. 34.0 global
filter String Adds filters to the dashboard at runtime. You can filter dataset fields by variables or specified values. The filters are configured with JSON strings in this format:
1{ 'datasetSystemName1': 
2    {'field1': ['!value1']}, 
3  'datasetSystemName2': 
4    {'field1': ['!value1', '!value2'],
5     'field2': ['!value3']} }

The dataset System Name is in the left panel of the edit page for the dataset. (If your org has namespaces, include the namespace prefix and two underscores before the dataset system name.) The field is a dimension in the dataset. To find the name, click the Explore icon to open the widget, select Show SAQL from the Options menu, and look for dimension names in the “group by” statements. The value is a field in the Salesforce object. To find the name, go to Setup, locate the object you want, and select Fields. Use the Field Name (also known as the API name). For custom fields, use the name with "__c" at the end.

Note: Only dimensions that have a list widget on the dashboard can be included in the filter attribute JSON.

34.0 global
height String Specifies the height of the dashboard, in pixels. 34.0 global
hideOnError Boolean Controls whether or not users see a dashboard that has an error. When this attribute is set to true, if the dashboard has an error, it won’t appear on the page. When set to false, the dashboard appears but doesn’t show any data except the error. An error can occur when a user doesn't have access to the dashboard or it has been deleted. 34.0 global
openLinksInNewWindow Boolean If false, links to other dashboards will be opened in the same window. 34.0 global
rendered Boolean Specifies whether or not the component is rendered on the page. 34.0 global
showSharing Boolean If true, and the dashboard is shareable, then the dashboard shows the Share icon. If false, the dashboard doesn't show the Share icon. To show the Share icon in the dashboard, the smallest supported frame size is 800 x 612 pixels. 34.0 global
showTitle Boolean If true, the dashboard’s title is included above the dashboard. If false, the dashboard appears without a title. 34.0 global
width String Specifies the width of the dashboard, in pixels or percent. Pixel values are simply the number of pixels, for example, 500. Percentage values specify the width of the containing HTML element and must include the percent sign, for example, 20%. 34.0 global