Client-Side Functionality
- 2 minutes to read
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 -> ASPxDashboard
How to migrate from ASPxDashboardViewer to ASPxDashboard working in the ViewerOnly mode
MVCxDashboardViewer -> MVCxDashboard
How to migrate from DashboardViewerExtension to DashboardExtension working in the ViewerOnly mode
The DashboardViewer extension, as well as other MVC extensions, offer an advanced client-side API in addition to a comprehensive server-side object model. To learn more, see the Client-Side API section that describes concepts common to all ASP.NET MVC extensions.
The client-side API exposed by DashboardViewer is implemented using JavaScript - an object oriented programming language that is interpreted by client browsers. On the client side, the DashboardViewer extension is represented by the MVCxClientDashboardViewer. To get access to the MVCxClientDashboardViewer via JavaScript, you need to specify the DashboardViewerSettings.Name property.
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 client-side DashboardViewer functionality are contained in the following namespaces: