All docs
V18.2
19.1 (preview)
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

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

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

Parameters

Type Name Description
String itemName

A string that specifies the component name of the dashboard item.

ASPxClientDashboardItemRequestUnderlyingDataParameters args

A ASPxClientDashboardItemRequestUnderlyingDataParameters object containing parameters used to obtain the underlying data.

ASPxClientDashboardItemRequestUnderlyingDataCompleted onCompleted

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);
    }
})
See Also