Gauge KPI Sparkline

targetValue

Number

The target value of the gauge KPI sparkline. The target value is between minValue and maxValue.

currentValue

Number

The current value of the gauge KPI sparkline. The current value is between minValue and maxValue.

minValue

Number

The minimum value of the gauge KPI sparkline. The minValue is less than maxValue.

maxValue

Number

The maximum value of the gauge KPI sparkline. The maxValue is more than minValue.

showLabel Optional

Boolean

Specifies whether to show the label of all the values provided in the sparkline. If false, it will not show labels. If true, it will only show the labels which fit inside the cell width and height. The cell should have enough width and height to show both graph and labels. The default value is true.

targetValueLabel Optional

String

The string to display as target value label. The default value is targetValue.

currentValueLabel Optional

String

The string to display as current value label. The default value is currentValue.

minValueLabel Optional

String

The string to display as minimum value label. The default value is minValue.

maxValueLabel Optional

String

The string to display as maximum value label. The default value is maxValue.

fontArray Optional

CalcArray

Array contains font format as string items for the four label types - * Target value label: Default value "16px Calibri" * Current value label: Default value "bold 22px Calibri" * Minimum and Maximum value labels: Default value "12px Calibri" showLabel option must be true.

minAngle Optional

Number

The minimum angle value of circle type. The minAnigle should be less than maxAngle. The angle values correspond to the time in the clock. 0 is 12 o'clock, -90 is 9 o'clock, 90 is 3 o'clock, and -180/180 is 6 o'clock. The default value is -90. gaugeType option must be 0 (circle type).

maxAngle Optional

Number

The maximum angle value of circle type. The maxAngle should be bigger than minAngle. The angle values correspond to the time in the clock. 0 is 12 o'clock, -90 is 9 o'clock, 90 is 3 o'clock, and -180/180 is 6 o'clock. The default value is 90. gaugeType option must be 0 (circle type).

radiusRatio Optional

Number

The value is calculated as the ratio of inner circle radius and outer circle radius. The outer circle radius value is decided by the cell size. The value ranges between 0 and 1. Default is 0. gaugeType option must be 0 (circle type).

gaugeType Optional

Number

The KPI sparkline type. 0 - Circle

1 - Vertical Bar

2 - Horizontal Bar The default type is circle.

colorRange Optional Repeatable

CalcArray

The color range between specified values. {startValue, endValue, color_string} Where startValue is the starting value in a range, endValue is the ending value in a range, and the color_string is the color of the range between the two specified value. The startValue must be less than the endValue and both the values should be between minValue and maxValue. Default color range from minValue to maxValue is filled with light gray color.