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
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)
Declaration
constructor(
dataItemProvider: DataDashboardItem,
modelJson?: any,
serializer?: DxDesigner.Analytics.Utils.ModelSerializer
)
Parameters
| Name |
Type |
Description |
| dataItemProvider |
DataDashboardItem |
|
| modelJson |
any |
A JSON object used for a dashboard deserialization. Do not pass this parameter directly.
|
| serializer |
DxDesigner.Analytics.Utils.ModelSerializer |
An object used for a dashboard deserialization. Do not pass this parameter directly.
|
Properties
absoluteVariationNumericFormat: AbsoluteVariationNumericFormat
actualValue Property
Declaration
actualValue: ko.Observable<Measure>
Property Value
deltaOptions Property
Declaration
deltaOptions: DeltaOptions
Property Value
itemType Property
Declaration
itemType: ko.Observable<string>
Property Value
name Property
Declaration
name: ko.Observable<string>
Property Value
percentOfTargetNumericFormat: PercentOfTargetNumericFormat
percentVariationNumericFormat: PercentVariationNumericFormat
targetValue Property
Declaration
targetValue: ko.Observable<Measure>
Property Value
Methods
getInfo Method
Declaration
getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray
Returns
| Type |
Description |
| DxDesigner.Analytics.Utils.ISerializationInfoArray |
|