ASPxClientDashboardItemUnderlyingData Class

Represents a list of records from the dashboard data source.

Namespace: DevExpress.DashboardWeb.Scripts

Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.Scripts.dll


public class ASPxClientDashboardItemUnderlyingData
Public Class ASPxClientDashboardItemUnderlyingData

An ASPxClientDashboardItemUnderlyingData object is returned by the ASPxClientDashboard.RequestUnderlyingData / ASPxClientDashboardViewer.RequestUnderlyingData methods.

You can also obtain the underlying data for specific visual elements when handling client-side events, for instance, the ASPxClientDashboard.ItemClick / ASPxClientDashboardViewer.ItemClick events. Use the ASPxClientDashboardItemClickEventArgs.RequestUnderlyingData method to do this.


The following example demonstrates how to get underlying data corresponding to a particular visual element using the ASPxClientDashboard's API.

In this example, the ASPxClientDashboard.ItemClick event is handled to obtain underlying data and invoke the dxPopup widget with the child dxDataGrid. In the event handler, the ASPxClientDashboardItemClickEventArgs.RequestUnderlyingData method is called to obtain records from the dashboard's data source. The dxDataGrid is used to display these records.

function getUnderlyingData(args) {
    var underlyingData = [];

    args.RequestUnderlyingData(function (data) {
        dataMembers = data.GetDataMembers();
        for (var i = 0; i < data.GetRowCount() ; i++) {
            var dataTableRow = {};
            $.each(dataMembers, function (_, dataMember) {
                dataTableRow[dataMember] = data.GetRowValue(i, dataMember);

        var $grid = $('<div/>');
            height: 500,
            scrolling: {
                mode: 'virtual'
            dataSource: underlyingData

        var popup = $("#myPopup").data("dxPopup");
        $popupContent = popup.content();

function initPopup() {
        width: 800, height: 600,
        title: "Underlying data",
        showCloseButton: true


See Also