Skip to main content

CreateDashboardExtension Class

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

#Declaration

TypeScript
export class CreateDashboardExtension implements IExtension

#Remarks

When registered, the CreateDashboardExtension adds the “New…” item to the dashboard menu.

To get access to the CreateDashboardExtension settings, call the control’s findExtension(extensionName) method and pass the extension’s name as a parameter.

JavaScript
var ext = dashboardControl.findExtension('createDashboard');

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

JavaScript
dashboardControl.unregisterExtension('createDashboard');

You can also call the control’s option method to change the extension options.

#Implements

IExtension

#constructor(dashboardControl)

Initializes a new instance of the CreateDashboardExtension class.

#Declaration

TypeScript
constructor(
    dashboardControl: DevExpress.Dashboard.DashboardControl
)

#Parameters

Name Type Description
dashboardControl DashboardControl

A Web Dashboard control that owns the extension.

#Properties

#name Property

Specifies the unique extension name.

#Declaration

TypeScript
name: string

#Property Value

Type Description
string

The unique extension name. The return value is createDashboard.

#Remarks

Use the createDashboard name in the following cases:

  • Call the DashboardControl.findExtension method and pass the extension name as a parameter to access the extension.
  • Call the control’s option method to change the extension options.

Warning

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

#showCreateNewDashboard Property

Opens the “New…” dashboard menu page.

#Declaration

TypeScript
showCreateNewDashboard: () => void

#Property Value

Type
() => 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

TypeScript
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 object that is resolved after the action is completed.

#Remarks

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

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

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

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

#start Method

Registers the CreateDashboardExtension extension.

#Declaration

TypeScript
start(): void

#stop Method

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

#Declaration

TypeScript
stop(): void