The requested page is not available for the requested platform. You are viewing the content for Default platform.

KpiElement Class

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

Declaration

export class KpiElement extends SerializableModel implements IBindingModelProvider

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.

Inheritance

constructor(dataItemProvider)

Declaration

constructor(dataItemProvider: DataDashboardItem, modelJson?: any, serializer?: DxDesigner.Analytics.Utils.ModelSerializer)

Parameters

Name Type Description
dataItemProvider DataDashboardItem

Optional Parameters

Name Type Default Description
modelJson any null

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

serializer DxDesigner.Analytics.Utils.ModelSerializer null

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

Properties

absoluteVariationNumericFormat Property

Declaration

absoluteVariationNumericFormat: AbsoluteVariationNumericFormat

Property Value

Type Description
AbsoluteVariationNumericFormat

actualValue Property

Declaration

actualValue: ko.Observable<Measure>

Property Value

Type Description
ko.Observable<Measure>

deltaOptions Property

Declaration

deltaOptions: DeltaOptions

Property Value

Type Description
DeltaOptions

itemType Property

Declaration

itemType: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

name Property

Declaration

name: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

percentOfTargetNumericFormat Property

Declaration

percentOfTargetNumericFormat: PercentOfTargetNumericFormat

Property Value

Type Description
PercentOfTargetNumericFormat

percentVariationNumericFormat Property

Declaration

percentVariationNumericFormat: PercentVariationNumericFormat

Property Value

Type Description
PercentVariationNumericFormat

targetValue Property

Declaration

targetValue: ko.Observable<Measure>

Property Value

Type Description
ko.Observable<Measure>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationInfoArray