ASPxClientDashboardItemDataAxis Class

An axis that contains data points corresponding to the specified value hierarchy.

Declaration

declare class ASPxClientDashboardItemDataAxis

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.

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, the pivot grid has the “Row” and “Column” axes, the chart has the “Argument” and “Series” axes, etc.

The ASPxClientDashboardItemDataAxis.GetRootPoint method returns the root point on the current axis. The ASPxClientDashboardItemDataAxis.GetPoints method returns all axis points on the current axis.

The ASPxClientDashboardItemDataAxis.GetDimensions method returns dimensions that are used to create a hierarchy of axis points for the current axis.

Warning

A use of 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.

Methods

GetDimensions Method

Gets the dimensions used to create a hierarchy of axis points belonging to the current axis.

Declaration

GetDimensions(): ASPxClientDashboardItemDataDimension[]

Returns

Type	Description
ASPxClientDashboardItemDataDimension[]	An array of ASPxClientDashboardItemDataDimension objects that contain the dimension metadata.

GetPointByUniqueValues(uniqueValues) Method

Returns the data point for the specified axis by unique values.

Declaration

GetPointByUniqueValues(
    uniqueValues: any[]
): ASPxClientDashboardItemDataAxisPoint

Parameters

Name	Type	Description
uniqueValues	any[]	A hierarchy of unique values identifying the required data point.

Returns

Type	Description
ASPxClientDashboardItemDataAxisPoint	An ASPxClientDashboardItemDataAxisPoint object representing the data point belonging to the specified axis.

GetPoints Method

Returns axis points corresponding to values of the last-level dimension.

Declaration

GetPoints(): ASPxClientDashboardItemDataAxisPoint[]

Returns

Type	Description
ASPxClientDashboardItemDataAxisPoint[]	An array of ASPxClientDashboardItemDataAxisPoint objects that are axis points corresponding to values of the last-level dimension.

Remarks

If the Drill-Down feature is enabled, the GetPoints method returns axis points corresponding to dimension values currently displayed within the dashboard item.

GetPointsByDimension(dimensionId) Method

Returns axis points corresponding to the specified dimension.

Declaration

GetPointsByDimension(
    dimensionId: string
): ASPxClientDashboardItemDataAxisPoint[]

Parameters

Name	Type	Description
dimensionId	string	A String that is the dimension identifier.

Returns

Type	Description
ASPxClientDashboardItemDataAxisPoint[]	An array of ASPxClientDashboardItemDataAxisPoint objects that represent data points in a multidimensional space.

GetRootPoint Method

Gets the root axis point belonging to the current ASPxClientDashboardItemDataAxis.

Declaration

GetRootPoint(): ASPxClientDashboardItemDataAxisPoint

Returns

Type	Description
ASPxClientDashboardItemDataAxisPoint	An ASPxClientDashboardItemDataAxisPoint object that is the root axis point.