The notes and links widget is similar to free text widget, but allows for more formatting options.
This widget supports template variables. Use $<VARIABLE_NAME>.value syntax to dynamically update the widget content. For example, $env.value updates the value of a link to the selected environment.
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
Field
Type
Description
background_color
string
Background color of the note.
content [required]
string
Content of the note.
font_size
string
Size of the text.
has_padding
boolean
Whether to add padding or not.
show_tick
boolean
Whether to show a tick or not.
text_align
enum
How to align the text on the widget.
Allowed enum values: center,left,right
tick_edge
enum
Define how you want to align the text on the widget.
Allowed enum values: bottom,left,right,top
tick_pos
string
Where to position the tick on an edge.
type [required]
enum
Type of the note widget.
Allowed enum values: note
vertical_align
enum
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"
}Additional helpful documentation, links, and articles:
