Difference between revisions of "Component: Dashboard Text (Controls)"

From Flowcode Help
Jump to navigationJump to search
(XML import of component documentation)
 
(XML import)
Line 4: Line 4:
 
|-
 
|-
 
| width="20%" style="color: gray;" | Author
 
| width="20%" style="color: gray;" | Author
−
| [http://www.matrixltd.com Matrix Ltd]
+
| Matrix Ltd
 
|-
 
|-
 
| width="20%" style="color: gray;" | Version
 
| width="20%" style="color: gray;" | Version
Line 15: Line 15:
  
  
−
==[[File:Component Icon 7ade85db_6ca2_48bf_b19c_8148ebda497b.png|Image]] Dashboard Text component==
+
==[[Media:Component Icon 7ade85db_6ca2_48bf_b19c_8148ebda497b.png|Image]] Dashboard Text component==
−
Simulation only text component for adding readouts to the dashboard panel.
+
 
  
 
==Examples==
 
==Examples==
Line 29: Line 29:
  
 
===<span style="font-weight: normal;"><u><tt>Clear</tt></u></span>===
 
===<span style="font-weight: normal;"><u><tt>Clear</tt></u></span>===
−
Clear all text from the display.
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
'''Parameters'''
 
'''Parameters'''
Line 42: Line 44:
  
 
===<span style="font-weight: normal;"><u><tt>PrintString</tt></u></span>===
 
===<span style="font-weight: normal;"><u><tt>PrintString</tt></u></span>===
−
Print a string to the display, and leave the cursor at the end of the current string.
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
'''Parameters'''
 
'''Parameters'''
  
−
:[[Variable Types|STRING]] ''Text''
+
:[[Variable Types|STRING]] ''in_string''
−
::The string to send to the display.
 
  
  
Line 56: Line 59:
  
 
===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>===
 
===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>===
−
Print a number to the display, with formatting for the number of decimal places.
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
'''Parameters'''
 
'''Parameters'''
  
 
:[[Variable Types|FLOAT]] ''Number''
 
:[[Variable Types|FLOAT]] ''Number''
−
::The number to display.
 
  
 
:[[Variable Types|BYTE]] ''Places''
 
:[[Variable Types|BYTE]] ''Places''
−
::The number of decimal places.
 
  
  
Line 73: Line 76:
  
 
===<span style="font-weight: normal;"><u><tt>PrintLine</tt></u></span>===
 
===<span style="font-weight: normal;"><u><tt>PrintLine</tt></u></span>===
−
Send a complete  line of text to the display - a line feed is automatically added to
+
''<span style="color:red;">No additional information</span>''
 +
 
  
−
put the cursor at the next line.
 
  
 
'''Parameters'''
 
'''Parameters'''
  
−
:[[Variable Types|STRING]] ''Text''
+
:[[Variable Types|STRING]] ''in_string''
−
::The text to display.
 
  
  
Line 91: Line 93:
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Lines</u></span>
+
<span style="font-weight: normal;"><u>Start Text</u></span>
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''lines''.
+
This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''text''.
  
−
Number of lines of text to show on the display.
+
''<span style="color:red;">No additional information</span>''
−
 
 
−
<span style="font-weight: normal;"><u>Start Text</u></span>
 
  
−
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.
 
  
 
<span style="font-weight: normal;"><u>Font</u></span>
 
<span style="font-weight: normal;"><u>Font</u></span>
Line 107: Line 105:
 
This property is of type ''Font picker'' and can be referenced with the variable name ''Font''.
 
This property is of type ''Font picker'' and can be referenced with the variable name ''Font''.
  
−
Font to use for the text.
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
<span style="font-weight: normal;"><u>Horizontal Align</u></span>
 
<span style="font-weight: normal;"><u>Horizontal Align</u></span>
Line 113: Line 113:
 
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''AlignX''.
 
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.
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
<span style="font-weight: normal;"><u>Vertical Align</u></span>
 
<span style="font-weight: normal;"><u>Vertical Align</u></span>
  
 
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''AlignY''.
 
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''AlignY''.
−
 
−
Vertical alignment of the text.
 
−
 
−
<span style="font-weight: normal;"><u>Scrolling</u></span>
 
−
 
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''auto_scroll''.
 
  
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''
Line 133: Line 129:
 
This property is of type ''Color picker'' and can be referenced with the variable name ''Color''.
 
This property is of type ''Color picker'' and can be referenced with the variable name ''Color''.
  
−
Colour to print the text ("ink")
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
<span style="font-weight: normal;"><u>Background</u></span>
 
<span style="font-weight: normal;"><u>Background</u></span>
Line 139: Line 137:
 
This property is of type ''Color picker'' and can be referenced with the variable name ''Background''.
 
This property is of type ''Color picker'' and can be referenced with the variable name ''Background''.
  
−
Coloour for the text background ("Paper")
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
<span style="font-weight: normal;"><u>Border</u></span>
 
<span style="font-weight: normal;"><u>Border</u></span>
Line 145: Line 145:
 
This property is of type ''Color picker'' and can be referenced with the variable name ''Border''.
 
This property is of type ''Color picker'' and can be referenced with the variable name ''Border''.
  
−
Colour for the component border.
+
''<span style="color:red;">No additional information</span>''
 +
 
  
−
<span style="font-weight: normal;"><u>Border Thickness</u></span>
+
 
 +
<span style="font-weight: normal;"><u>Thickness</u></span>
  
 
This property is of type ''Floating point'' and can be referenced with the variable name ''bezel_thick''.
 
This property is of type ''Floating point'' and can be referenced with the variable name ''bezel_thick''.
  
−
Width of the outer bezel.
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
<span style="font-weight: normal;"><u>Margin</u></span>
 
<span style="font-weight: normal;"><u>Margin</u></span>
Line 157: Line 161:
 
This property is of type ''Floating point'' and can be referenced with the variable name ''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.
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
 +
 
 +
<span style="font-weight: normal;"><u>Lines</u></span>
 +
 
 +
This property is of type ''Signed integer'' and can be referenced with the variable name ''lines''.
 +
 
 +
''<span style="color:red;">No additional information</span>''

Revision as of 11:11, 16 January 2014


Author Matrix Ltd
Version 1.0
Category Controls


Image Dashboard Text component

Examples

No additional examples


Downloadable macro reference

This component does not contain any downloadable macros

Simulation macro reference

Clear

No additional information


Parameters

This macro has no parameters


Return value

This call does not return a value


PrintString

No additional information


Parameters

STRING in_string


Return value

This call does not return a value


PrintNumber

No additional information


Parameters

FLOAT Number
BYTE Places


Return value

This call does not return a value


PrintLine

No additional information


Parameters

STRING in_string


Return value

This call does not return a value



Property reference

Start Text

This property is of type Multiple lines of text and can be referenced with the variable name text.

No additional information


Font

This property is of type Font picker and can be referenced with the variable name Font.

No additional information


Horizontal Align

This property is of type Fixed list of ints and can be referenced with the variable name AlignX.

No additional information


Vertical Align

This property is of type Fixed list of ints and can be referenced with the variable name AlignY.

No additional information


Ink Color

This property is of type Color picker and can be referenced with the variable name Color.

No additional information


Background

This property is of type Color picker and can be referenced with the variable name Background.

No additional information


Border

This property is of type Color picker and can be referenced with the variable name Border.

No additional information


Thickness

This property is of type Floating point and can be referenced with the variable name bezel_thick.

No additional information


Margin

This property is of type Floating point and can be referenced with the variable name margin.

No additional information


Lines

This property is of type Signed integer and can be referenced with the variable name lines.

No additional information

Retrieved from "https://www.matrixtsl.com/wikiv6/index.php?title=Component:_Dashboard_Text_(Controls)&oldid=13255"