The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V18.2
19.1 (preview)
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

CreateDashboardExtension Class

A Web Dashboard extension that allows you to create a new dashboard.

Declaration

export class CreateDashboardExtension implements IExtension

Remarks

When registered, the CreateDashboardExtension adds the "New..." item to the dashboard menu.

To remove this item from the menu, call the unregisterExtension(extensionNames) method and pass the extension's unique name as a parameter:

dashboardControl.unregisterExtension('create-dashboard');

Implements

constructor(dashboardControl)

Initializes a new instance of the CreateDashboardExtension class.

Declaration

constructor(dashboardControl: DashboardControl)

Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

Properties

name Property

Specifies a unique extension name.

Declaration

name: string

Property Value

Type Description
string

A unique extension name. The return value is 'create-dashboard'.

Remarks

Warning

Do not change a unique name of the extension registered in the Web Dashboard in order to avoid exceptions.

showCreateNewDashboard Property

Opens the "New..." dashboard menu page.

Declaration

showCreateNewDashboard: () => void

Property Value

Type Description
() => void

Remarks

Note that the dashboard menu is available if Web Dashboard operates in the designer mode.

Methods

performCreateDashboard(dashboardName, dashboardJson) Method

Creates a new dashboard with a specified name and JSON model.

Declaration

performCreateDashboard(dashboardName: string, dashboardJson: string): JQueryPromise<void>

Parameters

Name Type Description
dashboardName string

The name of the created dashboard.

dashboardJson string

A dashboard model encoded in the JSON format.

Returns

Type Description
JQueryPromise<void>

A JQuery promise.

Remarks

The following code creates a copy of the opened dashboard with the New Dashboard name:

var extCreateDashboard = dashboardControl.findExtension("create-dashboard");
var dashboardName = "New Dashboard";
extCreateDashboard.performCreateDashboard(dashboardName, dashboardControl.dashboard().getJSON());

To create a new dashboard, pass an empty model as a parameter:

extCreateDashboard.performCreateDashboard(dashboardName, new DevExpress.Dashboard.Model.Dashboard({}));

start Method

Registers the CreateDashboardExtension extension.

Declaration

start(): void

stop Method

Contains code that is executed when you unregister the dashboard extension.

Declaration

stop(): void