Skip to main content

ItemDataDeltaValue Interface

Provides delta element values.

#Declaration

TypeScript
export interface ItemDataDeltaValue

#Methods

#getAbsoluteVariation Method

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

#Declaration

TypeScript
getAbsoluteVariation(): ItemDataMeasureValue

#Returns

Type Description
ItemDataMeasureValue

An ItemDataMeasureValue object that contains the measure value and display text.

#getActualValue Method

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

#Declaration

TypeScript
getActualValue(): ItemDataMeasureValue

#Returns

Type Description
ItemDataMeasureValue

An ItemDataMeasureValue object that contains the measure value and display text.

#getDisplaySubValue1 Method

Provides access to the first additional delta value.

#Declaration

TypeScript
getDisplaySubValue1(): ItemDataMeasureValue

#Returns

Type Description
ItemDataMeasureValue

An ItemDataMeasureValue object that contains the measure value and display text.

#getDisplaySubValue2 Method

Provides access to the second additional delta value.

#Declaration

TypeScript
getDisplaySubValue2(): ItemDataMeasureValue

#Returns

Type Description
ItemDataMeasureValue

An ItemDataMeasureValue object that contains the measure value and display text.

#getDisplayValue Method

Provides access to the main delta value.

#Declaration

TypeScript
getDisplayValue(): ItemDataMeasureValue

#Returns

Type Description
ItemDataMeasureValue

An ItemDataMeasureValue object that contains the measure value and display text.

#getIndicatorType Method

Gets the type of delta indicator.

#Declaration

TypeScript
getIndicatorType(): ItemDataMeasureValue

#Returns

Type Description
ItemDataMeasureValue

An ItemDataMeasureValue object that is the type of delta indicator.

#getIsGood Method

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

#Declaration

TypeScript

#Returns

Type Description
ItemDataMeasureValue

A ItemDataMeasureValue 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

TypeScript
getPercentOfTarget(): ItemDataMeasureValue

#Returns

Type Description
ItemDataMeasureValue

A ItemDataMeasureValue 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

TypeScript
getPercentVariation(): ItemDataMeasureValue

#Returns

Type Description
ItemDataMeasureValue

An ItemDataMeasureValue object that contains the measure value and display text.

#getTargetValue Method

Provides access to the target value.

#Declaration

TypeScript
getTargetValue(): ItemDataMeasureValue

#Returns

Type Description
ItemDataMeasureValue

An ItemDataMeasureValue object that contains the measure value and display text.