KpiElement Class

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

Declaration

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.

Inherited Members

customProperties

disposed

itemType

name

getInfo

grabFrom(dataItemContainer)

Inheritance

SerializableModel

TypedSerializableModel

DataItemContainer

KpiElement

Gauge

Card

constructor(dataItemProvider)

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

Declaration

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

absoluteVariationNumericFormat: DevExpress.Dashboard.Model.AbsoluteVariationNumericFormat

Property Value

Type
AbsoluteVariationNumericFormat

actualValue Property

Declaration

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

Property Value

Type
Observable<Measure>

deltaOptions Property

Declaration

deltaOptions: DevExpress.Dashboard.Model.DeltaOptions

Property Value

Type
DeltaOptions

percentOfTargetNumericFormat Property

Declaration

percentOfTargetNumericFormat: DevExpress.Dashboard.Model.PercentOfTargetNumericFormat

Property Value

Type
PercentOfTargetNumericFormat

percentVariationNumericFormat Property

Declaration

percentVariationNumericFormat: DevExpress.Dashboard.Model.PercentVariationNumericFormat

Property Value

Type
PercentVariationNumericFormat

targetValue Property

Declaration

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

Property Value

Type
Observable<Measure>