Component: Dashboard Text (Runtime Tools): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd
Version	1.1
Category	Runtime Tools

Dashboard Text component

A simulation only text box that can be used to display text and numbers.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Dashboard_Text.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Dashboard_Text.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Clear

	Clear
Remove all text from the display.
- VOID	Return

PrintLine

	PrintLine
DIsplay the given string on a new line. If the display is full, it will scroll upwards to make space.
- STRING	Text
The text to add to the display.
- VOID	Return

PrintNumber

	PrintNumber
Write the given number to the display. It will be placed immediately after the last character on the display without beginning a new line.
- FLOAT	Number

- BYTE	Places

- VOID	Return

PrintString

	PrintString
Add the given text to the display immediately after the most recent character and without beginning a new line.
- STRING	Text
The text to add to the display.
- VOID	Return

Property reference

	Properties
	Text
	Start Text
Set the text that will appear when the component is initialised.
	Lines
Set the number of lines of text that the display will show. Lines will scroll off the top of the box once the display is full.
	Font
Choose the font for the text. Any font installed on your PC can be used. If your file is opened on another computer which does not have the specified font, an alternative will automatically be chosen.
	Horizontal Align
Choose whether text will be aligned to the left, right or centre of the box width.
	Vertical Align
Choose whether text will be aligned wih the top, bottom or middle of the box height.
	Colors
	Text
Color for the text characters.
	Background
Color for the box background.
	Bezel
Color for the bezel (3D border)
	Bezel
	Thickness
The thickness of the bezel (3D border). This thickness will be maintained even when the component is resized.
	Margin
Set the margin size. This is used to insert a small blank space to the left and right of the text, so that characters are not placed right up against the bezel.

@@ Line 14: / Line 14: @@
 ==Dashboard Text component==
 A simulation only text box that can be used to display text and numbers.
+==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Dashboard_Text.fcfx FC_Comp_Source_Dashboard_Text.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Dashboard_Text.fcfx FC_Comp_Source_Dashboard_Text.fcfx]
 ==Detailed description==
 ''No detailed description exists yet for this component''
 ==Examples==
@@ Line 25: / Line 75: @@
-==Downloadable macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
+===Clear===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear'''
+| width="90%" class="mtx-class-macrohead" | '''Clear'''
 |-
 | colspan="2" | Remove all text from the display.&nbsp;
@@ Line 40: / Line 101: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===PrintLine===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintString'''
+| width="90%" class="mtx-class-macrohead" | '''PrintLine'''
 |-
-| colspan="2" | Add the given text to the display immediately after the most recent character and without beginning a new line.&nbsp;
+| colspan="2" | DIsplay the given string on a new line.  If the display is full, it will scroll upwards to make space.&nbsp;
 |-
 |-
@@ Line 58: / Line 120: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===PrintNumber===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintNumber'''
+| width="90%" class="mtx-class-macrohead" | '''PrintNumber'''
 |-
 | colspan="2" | Write the given number to the display.  It will be placed immediately after the last character on the display without beginning a new line.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:]] -
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" | Number
 |-
@@ Line 81: / Line 144: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===PrintString===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintLine'''
+| width="90%" class="mtx-class-macrohead" | '''PrintString'''
 |-
-| colspan="2" | DIsplay the given string on a new line.  If the display is full, it will scroll upwards to make space.&nbsp;
+| colspan="2" | Add the given text to the display immediately after the most recent character and without beginning a new line.&nbsp;
 |-
 |-
@@ Line 97: / Line 161: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
+|-
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-propfolder" | Text
 |-
 |-
@@ Line 133: / Line 199: @@
 |-
 | colspan="2" | Choose whether text will be aligned wih the top, bottom or middle of the box height.&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Colors
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
@@ Line 148: / Line 218: @@
 |-
 | colspan="2" | Color for the bezel (3D border)&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Bezel
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
@@ Line 158: / Line 232: @@
 |-
 | colspan="2" | Set the margin size.  This is used to insert a small blank space to the left and right of the text, so that characters are not placed right up against the bezel.&nbsp;
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
-|-
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
-|-
 |}

SteveT (talk | contribs)