Skip to main content
All docs
V24.2

ASPxClientDashboardItemDataMeasure Class

Contains the measure metadata.

#Declaration

TypeScript
declare class ASPxClientDashboardItemDataMeasure

#Remarks

The measure metadata contains the following information:

Use the ASPxClientDashboardItemDataMeasure.Format method to format the specified value using the format setting for the current measure.

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.

See Also

#Properties

#DataMember Property

Gets the data member that identifies the data source list used to provide data for the current measure.

#Declaration

TypeScript
DataMember: string

#Property Value

Type Description
string

A string value that identifies the data source list used to provide data for the current measure.

#Id Property

Gets the measure identifier.

#Declaration

TypeScript
Id: string

#Property Value

Type Description
string

A string value that is the measure identifier.

#Name Property

Gets the name of the measure.

#Declaration

TypeScript
Name: string

#Property Value

Type Description
string

A string value that is the name of the measure.

#SummaryType Property

Gets the type of summary function calculated against the current measure.

#Declaration

TypeScript
SummaryType: string

#Property Value

Type Description
string

A string value that identifies the type of summary function calculated against the current measure.

#Methods

#Format(value) Method

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

#Declaration

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

See Also