ASPxClientDashboard.RequestUnderlyingData(String, ASPxClientDashboardItemRequestUnderlyingDataParameters, ASPxClientDashboardItemRequestUnderlyingDataCompleted) Method

Requests underlying data for the specified dashboard item.

Namespace: DevExpress.DashboardWeb.Scripts

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

Declaration

C#

public void RequestUnderlyingData(
    string itemName,
    ASPxClientDashboardItemRequestUnderlyingDataParameters args,
    ASPxClientDashboardItemRequestUnderlyingDataCompleted onCompleted
)

VB.NET

Public Sub RequestUnderlyingData(
    itemName As String,
    args As ASPxClientDashboardItemRequestUnderlyingDataParameters,
    onCompleted As ASPxClientDashboardItemRequestUnderlyingDataCompleted
)

Parameters

Name	Type	Description
itemName	String	A string that specifies the component name of the dashboard item.
args	ASPxClientDashboardItemRequestUnderlyingDataParameters	A ASPxClientDashboardItemRequestUnderlyingDataParameters object containing parameters used to obtain the underlying data.
onCompleted	ASPxClientDashboardItemRequestUnderlyingDataCompleted	A ASPxClientDashboardItemRequestUnderlyingDataCompleted object that references a method executed after the request is completed.

Remarks

Note that the RequestUnderlyingData method does not return data for calculated fields containing the Aggr function.

The following code snippet shows how to set the method’s parameters to obtain underlying data:

var requestParameters = {
    DataMembers: ['ProductName', 'OrderID']
};
Dashboard.RequestUnderlyingData("gaugeDashboardItem1", requestParameters, function(data) {
    var dataM = data.GetDataMembers();
    for(var i = 0; i < data.GetRowCount(); i++) {
        var dataTableRow = {};
        $.each(dataM, function(_, dataMember) {
            dataTableRow[dataMember] = data.GetRowValue(i, dataMember);
        });
        underlyingData.push(dataTableRow);
    }
})