The Notes & Links widget is similar to the free text widget but contains more formatting and display options.
Setup
- Enter the text you want to display. Markdown is supported.
- Select a preset template or customize the display options.
- Select a text size and the widget’s background color.
- To adjust the position of the text, click on the Alignment buttons. To not include padding, click No Padding.
- To include a pointer, click Show Pointer and select a position from the dropdown menu.
When you are ready to create the widget, click Save.
This widget supports template variables. Use the $<VARIABLE_NAME>.value syntax to dynamically update the widget content.
In this example, $env.value updates the value of a link to the selected environment.
API
This widget can be used with the Dashboards API. See the Dashboards API documentation for additional reference.
The dedicated widget JSON schema definition for the note widget is:
Expand All
Background color of the note.
Whether to add padding or not.
Whether to show a tick or not.
How to align the text on the widget.
Allowed enum values: center,left,right
Define how you want to align the text on the widget.
Allowed enum values: bottom,left,right,top
Where to position the tick on an edge.
Type of the note widget.
Allowed enum values: note
Vertical alignment.
Allowed enum values: center,top,bottom
{
"background_color": "string",
"content": "",
"font_size": "string",
"has_padding": false,
"show_tick": false,
"text_align": "string",
"tick_edge": "string",
"tick_pos": "string",
"type": "note",
"vertical_align": "string"
}
Further Reading
Additional helpful documentation, links, and articles:
