KPI List
The widget allows you to add a panel with multiple indicators to a dashboard. Each indicator in the widget can use columns from tables that are not linked in the Data Model.
Widget Settings
In addition to common widget settings, this widget has unique settings.
Data Settings
In the Data tab, you can add measures to the widget. In addition to standard local indicator settings, you can configure predefined filtering (+ Filter button) and click actions for each measure.
Display settings for measures:
- Title (can be hidden)
- Color:
- Auto
- Solid
- By rule (only rules with Solid or Custom mode are available for values)
- Custom (by formula)
- Display (Always / By variable / By formula)
If too many horizontally arranged indicators are added, they automatically wrap to the next line within the same widget.
Display Settings
In addition to standard display settings, the following settings are available for this widget:
- Measure title size
- Title position (top / bottom)
- Indicator size
- Measure font weight
- Alignment (left / center / right)
- Layout (vertical or horizontal arrangement)
Filtering Settings
The widget supports common filtering settings.
Widget Configuration in YAML
You can edit the widget not only in the view but also in the YAML editor. The table below lists the keys and values available for configuration. For details on working with the value key, see Dimension and measure values in YAML. Supported data formats are described on the corresponding page. Common widget parameters are described on the page Widget configuration in YAML.
Data Settings in YAML
| Key | Type | Definition |
|---|---|---|
| title | string | Title |
| showMarkdown | boolean | Description |
| markdownText | string | Description text |
| markdownMeasures | — | Measure in description |
| measures#Adding an indicator (measures key) | — | Indicators |
Adding an Indicator (measures key)
To add an indicator to the widget, use the measures block. The following keys are available within this block:
| Key | Type | Definition |
|---|---|---|
| name | string | Measure name |
| value | — | Measure formula |
| dbDataType | enum | Measure data type |
| format | enum | Format |
| formatting | enum | Formatting |
| formattingTemplate | string | Custom formatting Available only for CUSTOM formatting type |
| onClick | — | Click actions |
| showTitle | boolean | Show measure title |
| titleSize | number | Measure title size |
| position | enum | Position: - TOP — top- BOTTOM — bottom |
| alignment | enum | Alignment: - LEFT — left- CENTER — center- RIGHT — right |
| fontWeight | enum | Font weight: - NORMAL — normal- BOLD — bold |
| fontSize | number | Font size |
| color | — | Color: - AUTO — auto- BASE — basic- FORMULA — by formula- RULE — by rule |
| displayCondition | — | Display (display condition) |
| filters | — | Predefined filters |
Display Settings in YAML
| Key | Type | Definition |
|---|---|---|
| paddings | string | Side paddings |
| titleSize | number | Title size |
| titleColor | — | Title color: - AUTO — auto- BASE — basic |
| titleWeight | enum | Title font weight: - NORMAL — normal- BOLD — bold |
| displaySign | enum | Layout: - HORIZONTAL — horizontal- VERTICAL — vertical |
| markdownTextSize | number | Description text Specifies the Markdown description text size. Available only if the Description toggle is enabled |
Filtering Settings in YAML
| Key | Type | Definition |
|---|---|---|
| ignoreFilters | boolean | Ignore filters |
| filters | — | Predefined filters |
| stateName | string | State |
Example of a Configured Widget in the YAML Editor
widgets:
- key: kpi-list
apiVersion: "17"
type: KPI_LIST
settings:
title: ""
titleSize: 14
titleColor:
mode: AUTO
titleWeight: NORMAL
showMarkdown: false
markdownMeasures: []
markdownText: ""
measures:
- name: Store Count
value:
mode: FORMULA
formula: "#{Store Count}"
format:
value: NUMBER
mode: BASE
formatting:
value: AUTO
mode: BASE
color:
mode: AUTO
dbDataType: Int64
showName: true
displayCondition:
mode: DISABLED
filters: []
onClick: []
- name: Product Count
value:
mode: TEMPLATE
tableName: product
columnName: Product
templateName: countDistinct
format:
value: NUMBER
mode: BASE
formatting:
value: AUTO
mode: BASE
color:
mode: AUTO
dbDataType: Int64
showName: true
displayCondition:
mode: DISABLED
filters: []
onClick: []
- name: Sales Amount
value:
mode: TEMPLATE
tableName: sale
columnName: Sales Amount
templateName: sum
format:
value: NUMBER
mode: BASE
formatting:
mode: TEMPLATE
value: "#,###[$]"
color:
mode: BASE
value: "#6636c0"
dbDataType: Float64
showName: true
displayCondition:
mode: DISABLED
filters: []
onClick: []
- name: Profitability
value:
mode: FORMULA
formula: (sum("sale"."Sales Amount") - sum("sale"."Cost of Goods Sold")) /
sum("sale"."Sales Amount") * 100
format:
value: NUMBER
mode: BASE
formatting:
value: x.x[%]
mode: BASE
color:
mode: BASE
value: "#ff9f43"
dbDataType: Float64
showName: true
displayCondition:
mode: DISABLED
filters: []
onClick: []
stateName: null
filters: []
sorting: []
measuresTextWeight: NORMAL
measuresTextSize: 30
alignment: FULL
ignoreFilters: false
maxRowsName: 1
paddings: 8
markdownTextSize: 14
orientation: HORIZONTAL
measuresNamePosition: TOP
measuresNameSize: 12
textAlignment: CENTER
localApiVersion: "3"
Was the article helpful?