Client-Side Functionality

Important

This documentation applies to v16.2. Starting with v17.1, the ASPxDashboardViewer control is in maintenance mode. In v19.1, the new Web Dashboard Control replaces the old Web Dashboard Viewer. This means that the Web Dashboard Viewer will not be included in our installation packages. See our blog post for more information.

Refer to the following KB articles to learn how to migrate to ASPxDashboard / ASP.NET MVC Dashboard:

ASPxDashboardViewer, as well as other DevExpress ASP.NET controls, offer an advanced client-side API, in addition to the comprehensive server-side object model. To learn more, see the Client-Side Functionality section that describes concepts common to all ASP.NET controls.

The client-side API exposed by ASPxDashboardViewer is implemented using JavaScript - an object oriented programming language that is interpreted by client browsers. On the client-side, the ASPxDashboardViewer is represented by the ASPxClientDashboardViewer. To get access to the ASPxClientDashboardViewer via JavaScript, you should specify the ASPxDashboardViewer.ClientInstanceName property.

To learn, how to handle client-side events, see the Client-Side Events topic.

Note

Although the entire client API is available on the client side, it's strongly recommended that only the documented public client-side API should be used to realize any custom client functionality.

The classes that implement the ASPxDashboardViewer client-side functionality are contained in the following namespaces:

DevExpress.DashboardWeb.Scripts

DevExpress.DashboardWeb.Mvc.Scripts