Indicator
An Indicator is a widget designed to draw dashboard users’ attention to a specific metric.
Widget Settings
In addition to the common widget settings, this widget has unique configuration options.
Data Settings
You can add two indicators to the widget:
- The First (primary) indicator, displayed in large font
- The Second (secondary) indicator, shown above the first one
To add an indicator, assign a measure to it.
Measures support standard settings, as well as the following additional options:
- Font size
- Font weight
- Display type (regular or with trend indicator)
- Color:
- Auto (default; not customizable)
- Solid (select from palette)
- By rule (rules with Solid or Custom mode apply to values)
- Custom (by formula)
- Display condition (Always / By variable / By formula)
Display Settings
The widget supports standard display settings.
Filtering Settings
The widget supports standard filtering settings, except for the filter mode selection.
A filter configured within the widget cannot be removed in Browse mode.
Widget Configuration in YAML
The widget can be edited not only visually but also in the YAML editor. The table below lists the keys and values you can use for configuration. For details on working with the value key, refer to Dimension and Measure Values in YAML. Supported data formats are described on the corresponding page. General widget parameters are covered in 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 |
| firstMeasures / secondMeasures | — | First indicator / Second indicator |
First and Second Indicator Settings in YAML
To configure the first and second indicators, use the firstMeasures / secondMeasures keys. The following parameters are available within each block:
| Key | Type | Definition |
|---|---|---|
| name | string | Indicator name |
| value | — | Indicator formula |
| dbDataType | enum | Indicator data type |
| format | enum | Format |
| formatting | enum | Formatting |
| formattingTemplate | string | Custom formatting Available only for CUSTOM (Custom) formatting |
| fontSize | number | Font size |
| fontWeight | enum | Font weight: - NORMAL — Normal- BOLD — Bold |
| displaySign | enum | Display type: - NONE — Regular- INDICATOR — With trend arrow (increase/decrease) |
| color | — | Color: - AUTO — Auto- BASE — Solid- FORMULA — By formula- RULE — By rule |
| displayCondition | — | Display (display condition) |
Display Settings in YAML
| Key | Type | Definition |
|---|---|---|
| paddings | string | Side paddings |
| titleSize | number | Title size |
| titleColor | — | Title color: - AUTO — Auto- BASE — Solid |
| titleWeight | enum | Font weight: - NORMAL — Normal- BOLD — Bold |
| markdownTextSize | number | Description text Specifies the Markdown description font 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
- key: KPI_CHART (1)
apiVersion: "16"
type: KPI_CHART
settings:
displayCondition:
mode: DISABLED
secondMeasures: []
ignoreFilters: false
sorting: []
filters: []
firstMeasures:
- displayCondition:
mode: DISABLED
color:
mode: BASE
value: "#ff9f43"
formattingTemplate: "#,###[$]"
dbDataType: FLOAT
name: Sales amount
format: NUMBER
fontSize: 30
value:
mode: FORMULA
formula: sum("sale"."Sales amount")
formatting: CUSTOM
fontWeight: BOLD
displaySign: NONE
title: Sales amount
titleSize: 14
stateName: null
titleColor:
mode: AUTO
titleWeight: NORMAL
showMarkdown: false
markdownMeasures: []
markdownText: ""
Was the article helpful?