Home Elements Boards Recipes

DisplayLine Element

The DisplayLineElement allows drawing a simple fixed line on the display when the display supports pixel drawing.

It is not required for all displays to support all these Elements and when a device only has a simple LCD attached maybe only using the DisplayTextElements is appropriate.

The DisplayLineElement is included in the collection of core elements.

Element Configuration

The following properties are available for configuration of the element.

x1 – Specifies the ending x position of the line.

y1 – Specifies the ending y position of the line.

From the base DisplayOutputElement implementation the following properties are available for configuration:

x – Specifies the x position of the Element.

y – Specifies the y position of the Element.

w or width – Specifies the width of the Element.

h or height – Specifies the height of the Element.

color – Specifies the draw color of the Element. When no color is specified on the element the default color from the display is used.

background – Specifies the background color of the Element. When no color is specified on the element the default color from the display is used.

border – Specifies the border color of the Element. When no color is specified on the element the default color from the display is used.

value – Specifies a value for the Element. This is used for some Output Elements only.

clear – The value is cleared.

From the base element implementation the following properties are available for configuration:

title – Caption text for the element. Used by the element specific cards on the dash boards.

description – A line of text that gives a short description of the device used in the web UI.

room – The location of the device.

loglevel – This property holds the element specific log level. The default value is LOGGER_LEVEL_ERR == 1.

startup – This property can be used to start the element using a different initialization phase. Possible values are “sys”, “net”, “time”. See The Startup sequence.

Element Actions

The following actions can be sent to the element:

redraw – The display is updated.

Configuration Example

This example shows how to configure this element:

{
  "displayline": {
    "l": {
      "x0": 0,
      "y0": 12,
      "x1": 127,
      "y1": 12,
      "description": "Display a line"
    }
  }
}

Element State

The following properties are available with the current values at runtime

active - Is set to true when the element is active.

Example State

{
  "displayline/l": {
    "active": "true"
  }
}

See also

Tags

Element