Component: Dashboard Text (Controls)
| Author | Matrix Ltd |
| Version | 1.0 |
| Category | Controls |
Contents
Dashboard Text component
Simulation only text component for adding readouts to the dashboard panel.
Examples
No additional examples
Downloadable macro reference
This component does not contain any downloadable macros
Simulation macro reference
Clear
Clear all text from the display.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
PrintString
Print a string to the display, and leave the cursor at the end of the current string.
Parameters
- STRING Text
- The string to send to the display.
Return value
- This call does not return a value
PrintNumber
Print a number to the display, with formatting for the number of decimal places.
Parameters
- FLOAT Number
- The number to display.
- BYTE Places
- The number of decimal places.
Return value
- This call does not return a value
PrintLine
Send a complete line of text to the display - a line feed is automatically added to
put the cursor at the next line.
Parameters
- STRING Text
- The text to display.
Return value
- This call does not return a value
Property reference
Lines
This property is of type Signed integer and can be referenced with the variable name lines.
Number of lines of text to show on the display.
Start Text
This property is of type Multiple lines of text and can be referenced with the variable name text.
Some text to display when the project is initialialised.
Font
This property is of type Font picker and can be referenced with the variable name Font.
Font to use for the text.
Horizontal Align
This property is of type Fixed list of ints and can be referenced with the variable name AlignX.
Left to right alignment of the text.
Vertical Align
This property is of type Fixed list of ints and can be referenced with the variable name AlignY.
Vertical alignment of the text.
Scrolling
This property is of type Fixed list of ints and can be referenced with the variable name auto_scroll.
No additional information
Ink Color
This property is of type Color picker and can be referenced with the variable name Color.
Colour to print the text ("ink")
Background
This property is of type Color picker and can be referenced with the variable name Background.
Coloour for the text background ("Paper")
Border
This property is of type Color picker and can be referenced with the variable name Border.
Colour for the component border.
Border Thickness
This property is of type Floating point and can be referenced with the variable name bezel_thick.
Width of the outer bezel.
Margin
This property is of type Floating point and can be referenced with the variable name margin.
Set a margin for the left and right edges to leave a space between the text and the border.
