Skip to main content

KpiElement Class

Serves as the base for classes that provide data for card and gauge dashboard items.

#Declaration

TypeScript
export abstract class KpiElement extends DataItemContainer

#Remarks

The Card and Gauge classes derived from the KpiElement class provide measures for the CardItem and GaugeItem respectively.

The KpiElement class exposes the KpiElement.actualValue and KpiElement.targetValue properties. These properties hold Measure objects against which the actual and target values displayed within the card or gauge are calculated.

#constructor(dataItemProvider)

Initializes a new instance of the KpiElement class with specified settings.

#Declaration

TypeScript
constructor(
    dataItemProvider: DevExpress.Dashboard.Model.DataDashboardItem,
    modelJson?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

#Parameters

Name Type Description
dataItemProvider DataDashboardItem
modelJson any

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

#Properties

#absoluteVariationNumericFormat Property

#Declaration

TypeScript
absoluteVariationNumericFormat: DevExpress.Dashboard.Model.AbsoluteVariationNumericFormat

#Property Value

Type
AbsoluteVariationNumericFormat

#actualValue Property

#Declaration

TypeScript
actualValue: ko.Observable<DevExpress.Dashboard.Model.Measure>

#Property Value

Type
Observable<Measure>

#deltaOptions Property

#Declaration

TypeScript
deltaOptions: DevExpress.Dashboard.Model.DeltaOptions

#Property Value

Type
DeltaOptions

#percentOfTargetNumericFormat Property

#Declaration

TypeScript
percentOfTargetNumericFormat: DevExpress.Dashboard.Model.PercentOfTargetNumericFormat

#Property Value

Type
PercentOfTargetNumericFormat

#percentVariationNumericFormat Property

#Declaration

TypeScript
percentVariationNumericFormat: DevExpress.Dashboard.Model.PercentVariationNumericFormat

#Property Value

Type
PercentVariationNumericFormat

#targetValue Property

#Declaration

TypeScript
targetValue: ko.Observable<DevExpress.Dashboard.Model.Measure>

#Property Value

Type
Observable<Measure>