UnderlyingDataTargetValue Class

Dimension value used to obtain the underlying data.

Namespace: DevExpress.DashboardWpf

Assembly: DevExpress.Dashboard.v20.2.Wpf.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Dashboard, DevExpress.Wpf.Dashboard

Declaration

C#

public class UnderlyingDataTargetValue

VB.NET

Public Class UnderlyingDataTargetValue

Remarks

Use the UnderlyingDataTargetValue.DimensionID and UnderlyingDataTargetValue.Value properties to specify the dimension identifier and value, respectively.

The following code snippet illustrates the use of the UnderlyingDataTargetValue instance when obtaining the underlying data for the Beverages - Chang dimension values in the PieDashboardItem shown in the picture below.

C#

DashboardItem dashboardItem = dashboardControl1.Dashboard.Items.FirstOrDefault(i => i.Name == "Pies 1");
MultiDimensionalData displayedData = dashboardControl1.GetItemData(dashboardItem.ComponentName);

UnderlyingDataTargetValue targetValueRow1 = new UnderlyingDataTargetValue()
{
    DimensionID = displayedData.GetDimensions(DashboardDataAxisNames.ChartArgumentAxis)[0].ID,
    Value = "Beverages"
};
UnderlyingDataTargetValue targetValueRow2 = new UnderlyingDataTargetValue()
{
    DimensionID = displayedData.GetDimensions(DashboardDataAxisNames.ChartArgumentAxis)[1].ID,
    Value = "Chang"
};

DashboardUnderlyingDataSet ds = dashboardControl1.GetUnderlyingData(dashboardItem.ComponentName, 
    new List<UnderlyingDataTargetValue>(){targetValueRow1, targetValueRow2});

VB.NET

Dim dashboardItem As DashboardItem = dashboardControl1.Dashboard.Items.FirstOrDefault(Function(i) i.Name = "Pies 1")
Dim displayedData As MultiDimensionalData = dashboardControl1.GetItemData(dashboardItem.ComponentName)

Dim targetValueRow1 As New UnderlyingDataTargetValue() With {.DimensionID = displayedData.GetDimensions(DashboardDataAxisNames.ChartArgumentAxis)(0).ID, .Value = "Beverages"}
Dim targetValueRow2 As New UnderlyingDataTargetValue() With {.DimensionID = displayedData.GetDimensions(DashboardDataAxisNames.ChartArgumentAxis)(1).ID, .Value = "Chang"}

Dim ds As DashboardUnderlyingDataSet = dashboardControl1.GetUnderlyingData(dashboardItem.ComponentName, New List(Of UnderlyingDataTargetValue)() From {targetValueRow1, targetValueRow2})

Inheritance

Object

UnderlyingDataTargetValue