KPIItem¶
When assigning a rule to a property of KPIItem, the rule will be passed an instance of the following proxy class as an argument:
KPIItem Properties¶
| Property | Type | Required |
|---|---|---|
| CaptionLabel | string |
No |
| Icon | Image | No |
| MetricItems | MetricItem | No |
| OnPress | ActionOrRule | No |
| Progress | number |
No |
| ShowProgress | boolean |
No |
| Target | LinkQueryFunctionTarget | No |
| _Name | string |
No |
CaptionLabel¶
- type:
string
Icon¶
- type: Image
MetricItems¶
On Android, we currently have a limitation where we only support a maximum of 2 MetricItems. Additionally, on
Android, LeadingUnit of MetricItem is supported only when there is exactly 1 MetricItem in the array.
- type:
MetricItem[]
All array items must be of the type: MetricItem
OnPress¶
Action/Rule to be triggered when the item is pressed.
- type: ActionOrRule
- Formatter and Binding are not supported
Progress¶
This is used only when ShowProgress is enabled and only used in iOS
- type:
number
ShowProgress¶
This determines if the KPI Progress View should be enabled
- type:
boolean
Target¶
Definition of the target binding to dynamically populate the collection. You can also set this to binding/rule to return an array of data items.
Note: If this is set to binding/rule, you must return an array of data items, you can't return Target definition.
- type: LinkQueryFunctionTarget
_Name¶
- type:
string