Text
The widget allows you to add text blocks to a dashboard. Using Markdown markup language, you can also embed images, links, and more into the widget.
Widget Settings
Data Settings
In the data settings tab, you can:
- Enter text
- Add a measure
- View or edit the key
- Configure click actions
If the text contains a URL or image link and a click action is configured for the widget, then:
- Clicking the link opens the specified URL or image
- Clicking anywhere else in the widget (outside the link area) triggers the configured click action
Display Settings
The widget supports standard display settings, except for header size, header color, and font weight.
Filtering Settings
The widget supports standard filtering settings, except for filter modes.
In Browse mode, clicking the widget does not trigger any action. Measures update dynamically based on applied filters.
Widget Configuration in YAML
You can edit the widget not only in the visual editor 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.
Data Settings in YAML
| Key | Type | Definition |
|---|---|---|
| markdownText | string | Description text |
| measures | — | Measure |
| onClick | — | Click actions |
Adding a Measure (measures key)
To add a measure 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 (Custom) formatting type |
| displaySign | enum | Measure appearance: - NONE — standard- INDICATOR — indicator with arrow (growth/decline) |
| displayCondition | — | Show (display condition) |
Display Settings in YAML
| Key | Type | Definition |
|---|---|---|
| paddings | string | Side paddings |
Example of a Configured Widget in the YAML Editor
widgets:
- key: text
apiVersion: "16"
type: TEXT
settings:
paddings: 8
ignoreFilters: false
stateName: null
markdownText: This is a **Text** widget. Clicking it opens another view in the side panel.
measures: []
filters: []
markdownTextSize: 20
onClick:
- type: OPEN_VIEW
name: Open view
openIn: DRAWER_WINDOW
mode: GENERATED_BY_SCRIPT
parameters: []
scriptKey: 6909a6db-3f92-4796-a978-b6bd9a282b43
alignment: RIGHT
Was the article helpful?