ASPxClientDashboardItemDataAxisPoint Class

A point on the data axis.

Declaration

declare class ASPxClientDashboardItemDataAxisPoint

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, 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.

To obtain the parent point for the current axis point, use the ASPxClientDashboardItemDataAxisPoint.GetParent method. The ASPxClientDashboardItemDataAxisPoint.GetChildren method returns the collection of child axis points.

To obtain axis point values, use the ASPxClientDashboardItemDataAxisPoint.GetDimensionValue method.

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.

Methods

GetAxisName Method

Gets the name of the axis to which the current axis point belongs.

Declaration

GetAxisName(): string

Returns

Type	Description
string	A String that in the name of the axis.

Remarks

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

GetChildren Method

Gets the child axis points for the current axis point.

Declaration

GetChildren(): ASPxClientDashboardItemDataAxisPoint[]

Returns

Type	Description
ASPxClientDashboardItemDataAxisPoint[]	An array of ASPxClientDashboardItemDataAxisPoint objects representing child axis points.

GetDimension Method

Gets the last level dimension corresponding to the current axis point.

Declaration

GetDimension(): ASPxClientDashboardItemDataDimension

Returns

Type	Description
ASPxClientDashboardItemDataDimension	A ASPxClientDashboardItemDataDimension object that contains the dimension metadata.

GetDimensions Method

Gets the collection of dimensions used to create a hierarchy of axis points from the root point to the current axis point.

Declaration

GetDimensions(): ASPxClientDashboardItemDataDimension[]

Returns

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

GetDimensionValue Method

Gets the dimension values at the specified axis point.

Declaration

GetDimensionValue(
    dimensionId?: string
): ASPxClientDashboardItemDataDimensionValue

Parameters

Name	Type
dimensionId	string

Returns

Type	Description
ASPxClientDashboardItemDataDimensionValue	A ASPxClientDashboardItemDataDimensionValue object that contains the dimension values at the specified axis point.

GetDisplayText Method

Gets the display text corresponding to the current axis point.

Declaration

GetDisplayText(): string

Returns

Type	Description
string	A String that is the display text corresponding to the current axis point.

GetParent Method

Gets the parent axis point for the current axis point.

Declaration

GetParent(): ASPxClientDashboardItemDataAxisPoint

Returns

Type	Description
ASPxClientDashboardItemDataAxisPoint	An ASPxClientDashboardItemDataAxisPoint object representing the parent axis point.

GetUniqueValue Method

Gets the unique value corresponding to the current axis point.

Declaration

GetUniqueValue(): any

Returns

Type	Description
any	The unique value corresponding to the current axis point.

GetValue Method

Gets the value corresponding to the current axis point.

Declaration

GetValue(): any

Returns

Type	Description
any	The value corresponding to the current axis point.