Difference between revisions of "Component: String Label (Indicators)"
From Flowcode Help
Jump to navigationJump to search| (8 intermediate revisions by the same user not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TextLabel.fcfx FC_Comp_Source_TextLabel.fcfx] |
| + | |||
| + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TextLabel.fcfx FC_Comp_Source_TextLabel.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 28: | Line 40: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 37: | Line 59: | ||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
| + | |||
| + | ===DisplayString=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 57: | Line 90: | ||
| + | ===SetForegroundColour=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 73: | Line 107: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
Latest revision as of 13:13, 7 February 2023
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Indicators |
Contents
String Label component
Allows a numeric label to be displayed on the user panel. Used for displaying the value of a variable during simulation runtime. Provides up to 5 customisable ranges to automatically alter the colour of the label based on the value.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_TextLabel.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_TextLabel.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
DisplayString
|
DisplayString |
| Displays a string value on the label. | |
 - STRING
|
Value |
| Integer value to display | |
 - VOID
|
Return |
SetForegroundColour
|
|
SetForegroundColour |
| Allows the user to manually specify the default colour of the foreground text. | |
 - LONG
|
Colour |
| RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Title |
|
Show Title |
| Decides if the title is shown on the panel. | |
|
Title Text |
| Specifies the title displayed on the panel. | |
|
Title Scale |
| Specifies the size of the title on the panel, default 1.2 | |
|
Title Colour |
| Specifies the colour of the title text | |
|
|
Background Colour |
| Specifies the background colour of the title text | |
|
|
Title Offset |
| Distance above component center to draw the title | |
|
|
Label Properties |
|
|
Label Scale |
| Specifies the scale of the label text, default 1.0 | |
|
Colour Values |
| Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value | |
|
|
Defaults |
|
|
String Colour |
| The label Text colour | |
|
|
Value 1 |
|
|
Value |
|
|
String Colour |
| The label Text colour when in the specified range | |
|
|
Range 2 |
|
|
Value |
|
|
String Colour |
| The label Text colour when in the specified range | |
|
|
Range 3 |
|
|
Value |
|
|
String Colour |
| The label Text colour when in the specified range | |
|
|
Range 4 |
|
|
Value |
|
|
String Colour |
| The label Text colour when in the specified range | |
|
|
Range 5 |
|
|
Value |
|
|
String Colour |
| The label Text colour when in the specified range | |
