ASPxClientDashboardItemDataDimension Class

Contains the dimension metadata.

Declaration

declare class ASPxClientDashboardItemDataDimension

Remarks

The ASPxClientDashboardItemDataDimension class is included in the client-side API allowing you to obtain client data. Learn more at Obtaining Underlying and Displayed Data.

The ASPxClientDashboardItemDataDimension class instances are returned by the following methods:

• ASPxClientDashboardItemClickEventArgs.GetDimensions
• ASPxClientDashboardItemData.GetDimensions
• ASPxClientDashboardItemDataAxis.GetDimensions
• ASPxClientDashboardItemDataAxisPoint.GetDimension
• ASPxClientDashboardItemDataAxisPoint.GetDimensions

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.

Properties

DataMember Property

Gets the data member identifier for the current dimension.

Declaration

DataMember: string

Property Value

Type	Description
string	A string value that identifies a data member.

DateTimeGroupInterval Property

Gets the group interval for date-time values for the current dimension.

Declaration

DateTimeGroupInterval: string

Property Value

Type	Description
string	A string value that represents how date-time values are grouped.

Id Property

Gets the dimension identifier.

Declaration

Id: string

Property Value

Type	Description
string	A string value that is the dimension identifier.

Name Property

Gets or sets the name of the dimension.

Declaration

Name: string

Property Value

Type	Description
string	A string value that is the name of the dimension.

TextGroupInterval Property

Gets the group interval for string values.

Declaration

TextGroupInterval: string

Property Value

Type	Description
string	A string value that specifies the group interval for string values.

Methods

Format(value) Method

Formats the specified value using format settings of the current dimension.

Declaration

Format(
    value: any
): string

Parameters

Name	Type	Description
value	any	A value to be formatted.

Returns

Type	Description
string	A String that represents the formatted value.