Free Text Widget

Free text is a widget that allows you to add headings to your screenboard.

This is commonly used to state the overall purpose of the dashboard.

Setup

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 free text widget is:

Expand All

Field

Type

Description

color

string

Color of the text.

font_size

string

Size of the text.

text [required]

string

Text to display.

text_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

type [required]

enum

Type of the free text widget. Allowed enum values: free_text

{
  "color": "string",
  "font_size": "string",
  "text": "",
  "text_align": "string",
  "type": "free_text"
}