Skip to main content

ShowDashboard

Description​

Shows the specified dashboard in the tab.

Syntax​

// shellPaneTab points to instance of IShellPaneTab
const result = await shellPaneTab.ShowDashboard(dashboardID, data);

Parameters​

NameOptionalityTypeDescription
dashboardIDRequiredstringThe dashboard ID. The dashboard ID is
specified in the application definition file (appdef file).
dataRequiredanyData object to pass for the HTML code. The data object
shows as CustomDataProperty of the dashboard object.

Return type​

TypeDescription
Promise < null | IDashboard >Reference to the dashboard.

Exceptions​

ArgumentError - When dashboardID is null or undefined.