Skip to content

KPIItem

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


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.


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.


_Name

  • type: string