Skip to main content
All docs
V24.2

ASPxClientDashboardItemData Class

Represents multidimensional data visualized in the dashboard item.

#Declaration

TypeScript
declare class ASPxClientDashboardItemData

#Remarks

Each data-bound dashboard item uses a multidimensional representation of data (the ASPxClientDashboardItemData class). Thus the control can visualize information hierarchically. For instance, the pivot grid allows users to expand or collapse column/row field values to view data at different detail levels. In dashboard items, users can also drill up and down through data to move between detail levels. Call the ASPxClientDashboard.GetItemData method to obtain multidimensional data visualized in the specified dashboard item.

The value corresponding to a specific hierarchy level is stored in the ASPxClientDashboardItemDataAxisPoint class that defines a data point in a multidimensional space. Such data points are placed on a specific data axis that is represented by the ASPxClientDashboardItemDataAxis class. For instance, a pivot grid has the “Row” and “Column” axes, a chart has the “Argument” and “Series” axes, etc.

Use the following methods to access the displayed data.

To learn more, see the Obtain Underlying and Displayed Data in ASP.NET Web Forms Dashboard Control topic.

Warning

Use of the ASPxClientDashboard API reduces flexibility when you configure the control. The DashboardControl underlies the ASPxClientDashboard object. The control provides access to all client settings and allows you to implement complex scenarios. We recommend that you use the DashboardControl API to configure the Web Dashboard on the client. More information: Client-Side Functionality.

See Also

#Methods

#CreateTuple(values) Method

Creates a tuple based on the specified axes names and corresponding values.

#Declaration

TypeScript
CreateTuple(
    values: any[] | ASPxClientDashboardItemDataAxisPoint[]
): ASPxClientDashboardItemDataAxisPointTuple

#Parameters

Name Type Description
values any[] | ASPxClientDashboardItemDataAxisPoint[]

An array of name-value pairs containing the axis name and corresponding values.

#Returns

Type Description
ASPxClientDashboardItemDataAxisPointTuple

An ASPxClientDashboardItemDataAxisPointTuple object representing an axis point tuple.

#Remarks

For instance, you can use the following syntax to pass a name-value pair to the CreateTuple method.

var axisPointTuple = clientData.CreateTuple([{ AxisName: DashboardDataAxisNames.DefaultAxis, Value: ["UK", "Robert King"]}]);

#GetAxis(axisName) Method

Returns the specified data axis.

#Declaration

TypeScript
GetAxis(
    axisName: string
): ASPxClientDashboardItemDataAxis

#Parameters

Name Type Description
axisName string

A string value returned by the DashboardDataAxisNames class that specifies the name of the data axis.

#Returns

Type Description
ASPxClientDashboardItemDataAxis

A ASPxClientDashboardItemDataAxis object that contains data points corresponding to the specified value hierarchy.

See Also

#GetAxisNames Method

Gets the names of the axes that constitute the current ASPxClientDashboardItemData.

#Declaration

TypeScript
GetAxisNames(): string[]

#Returns

Type Description
string[]

An array of String values that represent the names of the axes.

#Remarks

The DashboardDataAxisNames class exposes constants that identify possible types of data axes.

#GetDataMembers Method

Returns an array of data members available in a data source.

#Declaration

TypeScript
GetDataMembers(): string[]

#Returns

Type Description
string[]

An array of string values that represent data members available in a data source.

#GetDeltas Method

Gets the deltas for the current ASPxClientDashboardItemData object.

#Declaration

TypeScript

#Returns

Type Description
ASPxClientDashboardItemDataDelta[]

An array of ASPxClientDashboardItemDataDelta objects containing the delta metadata.

See Also

#GetDeltaValue(deltaId) Method

Gets the summary value for the specified delta.

#Declaration

TypeScript
GetDeltaValue(
    deltaId: string
): ASPxClientDashboardItemDataDeltaValue

#Parameters

Name Type Description
deltaId string

A String that is the data item identifier.

#Returns

Type Description
ASPxClientDashboardItemDataDeltaValue

A ASPxClientDashboardItemDataDeltaValue object providing delta element values.

#Remarks

Use the ASPxClientDashboardItemDataDelta.Id property to obtain the data item identifier passed to the GetDeltaValue method. The ASPxClientDashboardItemDataDelta class objects are returned by the following properties.

See Also

#GetDimensions(axisName) Method

Gets the dimensions used to create a hierarchy of axis points for the specified axis.

#Declaration

TypeScript
GetDimensions(
    axisName: string
): ASPxClientDashboardItemDataDimension[]

#Parameters

Name Type Description
axisName string

A string value returned by the DashboardDataAxisNames class that specifies the name of the data axis.

#Returns

Type Description
ASPxClientDashboardItemDataDimension[]

An array of ASPxClientDashboardItemDataDimension objects containing the dimension metadata.

#GetMeasures Method

Gets the measures for the current ASPxClientDashboardItemData object.

#Declaration

TypeScript

#Returns

Type Description
ASPxClientDashboardItemDataMeasure[]

An array of ASPxClientDashboardItemDataMeasure objects containing the measure metadata.

See Also

#GetMeasureValue(measureId) Method

Returns a total summary value for the specified measure.

#Declaration

TypeScript
GetMeasureValue(
    measureId: string
): ASPxClientDashboardItemDataMeasureValue

#Parameters

Name Type Description
measureId string

A String that is the measure identifier.

#Returns

Type Description
ASPxClientDashboardItemDataMeasureValue

A ASPxClientDashboardItemDataMeasureValue object providing the measure value and display text.

#Remarks

Use the ASPxClientDashboardItemDataMeasure.Id property to obtain the data item identifier passed to the GetMeasureValue method. The ASPxClientDashboardItemDataMeasure class objects are returned by the following properties.

See Also

#GetSlice(tuple) Method

Gets the slice of the current ASPxClientDashboardItemData object by the specified axis point tuple.

#Declaration

TypeScript
GetSlice(
    tuple: ASPxClientDashboardItemDataAxisPointTuple | ASPxClientDashboardItemDataAxisPoint
): ASPxClientDashboardItemData

#Parameters

Name Type Description
tuple ASPxClientDashboardItemDataAxisPoint | ASPxClientDashboardItemDataAxisPointTuple

A ASPxClientDashboardItemDataAxisPointTuple object that is a tuple of axis points.

#Returns

Type Description
ASPxClientDashboardItemData

An ASPxClientDashboardItemData object that is the slice of the current client data object by the specified axis point tuple.