Difference between revisions of "Component: Dashboard Text (Runtime Tools)"
From Flowcode Help
Jump to navigationJump to search (Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.1 |- | width="20%" style="color:gray...") |
|||
| (14 intermediate revisions by the same user not shown) | |||
| Line 14: | Line 14: | ||
==Dashboard Text component== | ==Dashboard Text component== | ||
A simulation only text box that can be used to display text and numbers. | 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== | ==Detailed description== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 25: | Line 75: | ||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
| + | |||
| + | ===Clear=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 40: | Line 101: | ||
| + | ===PrintLine=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintLine''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | DIsplay the given string on a new line. If the display is full, it will scroll upwards to make space. |
|- | |- | ||
|- | |- | ||
| Line 58: | Line 120: | ||
| + | ===PrintNumber=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 66: | Line 129: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:]] - | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| width="90%" | Number | | width="90%" | Number | ||
|- | |- | ||
| Line 81: | Line 144: | ||
| + | ===PrintString=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintString''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Add the given text to the display immediately after the most recent character and without beginning a new line. |
|- | |- | ||
|- | |- | ||
| Line 97: | Line 161: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
| Line 107: | Line 169: | ||
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Text | ||
|- | |- | ||
|- | |- | ||
| Line 133: | Line 199: | ||
|- | |- | ||
| colspan="2" | Choose whether text will be aligned wih the top, bottom or middle of the box height. | | colspan="2" | Choose whether text will be aligned wih the top, bottom or middle of the box height. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colors | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| Line 148: | Line 218: | ||
|- | |- | ||
| colspan="2" | Color for the bezel (3D border) | | colspan="2" | Color for the bezel (3D border) | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Bezel | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | | 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. | | 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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Latest revision as of 13:09, 7 February 2023
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | Runtime Tools |
Contents
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. | |
