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.

Free Text

Setup

Configuration

  1. Enter text to display.
  2. Choose your text formatting.

API

This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:

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

default: free_text

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

Further Reading

Additional helpful documentation, links, and articles:

Building Dashboards using JSONDOCUMENTATION more more