ASPxClientDashboardItemDataDeltaValue Class

Provides delta element values.

Declaration

declare class ASPxClientDashboardItemDataDeltaValue

Remarks

The ASPxClientDashboardItemDataDeltaValue class provides access to different values for delta elements.

• the ASPxClientDashboardItemDataDeltaValue.GetActualValue and ASPxClientDashboardItemDataDeltaValue.GetTargetValue methods provide access to the actual and target values for the current delta element;
• the ASPxClientDashboardItemDataDeltaValue.GetIsGood method returns the value specifying the condition for displaying the delta indication;
• the ASPxClientDashboardItemDataDeltaValue.GetIndicatorType method returns the type of delta indicator;
• the ASPxClientDashboardItemDataDeltaValue.GetAbsoluteVariation, ASPxClientDashboardItemDataDeltaValue.GetPercentVariation and ASPxClientDashboardItemDataDeltaValue.GetPercentOfTarget methods return values that can be displayed in the delta element.
• the ASPxClientDashboardItemDataDeltaValue.GetDisplayValue, ASPxClientDashboardItemDataDeltaValue.GetDisplaySubValue1 and ASPxClientDashboardItemDataDeltaValue.GetDisplaySubValue2 methods return values actually displayed in the delta element.

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

GetAbsoluteVariation Method

Provides access to the absolute difference between the actual and target values.

Declaration

GetAbsoluteVariation(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that contains the measure value and display text.

GetActualValue Method

Provides access to the actual value displayed within the delta element.

Declaration

GetActualValue(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that contains the measure value and display text.

GetDisplaySubValue1 Method

Provides access to the first additional delta value.

Declaration

GetDisplaySubValue1(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that contains the measure value and display text.

Remarks

GetDisplaySubValue2 Method

Provides access to the second additional delta value.

Declaration

GetDisplaySubValue2(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that contains the measure value and display text.

Remarks

GetDisplayValue Method

Provides access to the main delta value.

Declaration

GetDisplayValue(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that contains the measure value and display text.

Remarks

GetIndicatorType Method

Gets the type of delta indicator.

Declaration

GetIndicatorType(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that is the type of delta indicator.

GetIsGood Method

Gets the value specifying the condition for displaying the delta indication.

Declaration

GetIsGood(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that is the value specifying the condition for displaying the delta indication.

GetPercentOfTarget Method

Provides access to the percentage of the actual value in the target value.

Declaration

GetPercentOfTarget(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that contains the measure value and display text.

GetPercentVariation Method

Provides access to the percent of variation between the actual and target values.

Declaration

GetPercentVariation(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that contains the measure value and display text.

GetTargetValue Method

Provides access to the target value.

Declaration

GetTargetValue(): ASPxClientDashboardItemDataMeasureValue

Returns

Type	Description
ASPxClientDashboardItemDataMeasureValue	A ASPxClientDashboardItemDataMeasureValue object that contains the measure value and display text.