Skip to main content

ShowPopupDashboard

Description

Shows a dashboard in a separate window.

Syntax

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

Parameters

NameOptionalityTypeDescription
dashboardIDRequiredstringThe id of the dashboard to show. The string id must match to one of the
dashboard ids in the application definition file (appdef file).
dataRequiredanyUser-defined data item that is passed to the new dashboard.
titleOrOptionsRequiredstring | 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.