Display or Stop Text on an IP Display

duration

How long the text displays (in seconds).

Integer

Optional

If not specified, the text displays indefinitely.

persistent

Whether the text continues to display when the screen content changes.

Boolean

Optional

Valid values include:

• “true”

• “false”

Default=”false”

textContent

The text to be displayed on the device.

String

Required

textBg

The text background.

Boolean

Optional

Valid values:

• “true”

• “false”

textBgColor

The text background color.

String

Optional

Valid values:

• SVG color name

• HEX code

textColor

The color of the text.

String

Optional

Valid values:

• SVG color name

• HEX code

For example, use either of the following to set the text color to black:

"textColor": "black"
"textColor": "#000000"

For more information, see HTML Color Names.

Default= “black”

textFont

The font of the text.

String

Optional

Valid values include:

• “acumin”

• “bookman”

• “din”

• “inter”

• “nixie”

• “overpass”

• “roboto”

Default= “inter”

textPosition

Where the text should be displayed on the screen.

String

Optional

Valid values include:

• “top”

• “middle”

• “bottom”

Default= “bottom”

textScroll

Whether text scroll is enabled.

Boolean

Optional

Valid values include:

• “true”

• “false”

Default=”true”

textScrollSpeed

The speed at which the text scrolls.

String

Optional

Valid values include (in increasing speed)

• “1”

• “2”

• “3”

• “4”

• “5”

Default= “1”

textSize

The size of the text.

String or Integer

Optional

Valid string values include:

• “tiny“ (equal to integer value 60)

• “small” (equal to integer value 100)

• “medium (equal to integer value 200)

• “large” (equal to integer value 30)

Valid integer values:  50 - 300

Default=”large” (in v5.6 and earlier)

Default=”small” (in v5.7 and later)