Component: String Label (Indicators): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix TSL
Version	1.0
Category	Indicators

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

@@ Line 15: / Line 15: @@
 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 Pack==
+==Component Source Code==
-SCADA
+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==
 ''No detailed description exists yet for this component''
 ==Examples==
@@ Line 29: / Line 59: @@
-==Downloadable macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
+===DisplayString===
+{| 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;" | '''DisplayString'''
+| width="90%" class="mtx-class-macrohead" | '''DisplayString'''
 |-
 | colspan="2" | Displays a string value on the label.&nbsp;
@@ Line 49: / Line 90: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===SetForegroundColour===
+{| 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;" | '''SetForegroundColour'''
+| width="90%" class="mtx-class-macrohead" | '''SetForegroundColour'''
 |-
 | colspan="2" | Allows the user to manually specify the default colour of the foreground text.&nbsp;
@@ Line 65: / Line 107: @@
 | 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="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Title
 |-
 |-
@@ Line 106: / Line 150: @@
 |-
 | colspan="2" | Distance above component center to draw the title&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Label Properties
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
@@ Line 116: / Line 164: @@
 |-
 | colspan="2" | Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Defaults
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
@@ Line 121: / Line 173: @@
 |-
 | colspan="2" | The label Text colour&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Value 1
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
@@ Line 131: / Line 187: @@
 |-
 | colspan="2" | The label Text colour when in the specified range&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Range 2
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
@@ Line 141: / Line 201: @@
 |-
 | colspan="2" | The label Text colour when in the specified range&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Range 3
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
@@ Line 151: / Line 215: @@
 |-
 | colspan="2" | The label Text colour when in the specified range&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Range 4
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
@@ Line 161: / Line 229: @@
 |-
 | colspan="2" | The label Text colour when in the specified range&nbsp;
+|-
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
+| width="90%" class="mtx-class-propfolder" | Range 5
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
@@ Line 171: / Line 243: @@
 |-
 | colspan="2" | The label Text colour when in the specified range&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)