Skip to main content

ShowPopupDashboard

Description​

Shows a dashboard in popup window.

Syntax​

// shellFrame points to instance of IShellFrame
const result = await shellFrame.ShowPopupDashboard(
dashboardID,
data,
titleOrOptions,
);

Parameters​

NameOptionalityTypeDescription
dashboardIDRequiredstringThe dashboard ID as defined in Application Definition File (appdef file).
dataRequiredanyThe custom data that is passed for dashboard.
Can be accessed with CustomDataProperty of IDashboard Interface.
titleOrOptionsOptionalundefined | string | DialogUIParamsTitle and UI options of the dashboard.
String Type: Defines the title of the dashboard.
Object Type: Defines the title and other UI options [Eg: title/isModal/isResizable/isDraggable].

Return type​

TypeDescription
Promise < IDashboard >The popup dashboard.

Exceptions​

ArgumentError - When dashboardID is null or undefined.