Jump to content

Component: String Label (Indicators): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,422 edits
XML import
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix TSL
| Matrix TSL
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
| 1.0
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| Indicators
| 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.


==[[File:Component Icon 9d05cfe0_9394_4b7f_83fa_7b001e12c5d3.png|Image]] String Label component==
==Component Source Code==
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.


==Examples==
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]
''<span style="color:red;">No additional examples</span>''


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]


==Downloadable macro reference==
==Detailed description==


''This component does not contain any downloadable macros''


==Simulation macro reference==


===<span style="font-weight: normal;"><u><tt>DisplayString</tt></u></span>===
Displays a string value on the label.


'''Parameters'''


:[[Variable Types|<- STRING]] ''Value''
::Integer value to display
::''This parameter may be returned back to the caller''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>SetBackgroundColour</tt></u></span>===
Allows the user to manually specify the default colour of the background.


'''Parameters'''


:[[Variable Types|LONG]] ''Colour''
::RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent




'''Return value'''


:''This call does not return a value''
''No detailed description exists yet for this component''


==Examples==


===<span style="font-weight: normal;"><u><tt>SetForegroundColour</tt></u></span>===
Allows the user to manually specify the default colour of the foreground text.


'''Parameters'''


:[[Variable Types|LONG]] ''Colour''
::RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent




'''Return value'''


:''This call does not return a value''








==Property reference==
<span style="font-weight: normal;"><u>Show Title</u></span>


This property is of type ''True or false'' and can be referenced with the variable name ''ShowTitle''.


Decides if the title is shown on the panel.


<span style="font-weight: normal;"><u>Title Text</u></span>


This property is of type ''Line of text'' and can be referenced with the variable name ''Title''.


Specifies the title displayed on the panel.


<span style="font-weight: normal;"><u>Title Scale</u></span>
''<span style="color:red;">No additional examples</span>''


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


Specifies the size of the title on the panel, default 1.2


<span style="font-weight: normal;"><u>Foreground Colour</u></span>


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


Specifies the foreground colour of the title text


<span style="font-weight: normal;"><u>Background Colour</u></span>


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


Specifies the background colour of the title text


<span style="font-weight: normal;"><u>Label Scale</u></span>


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


Specifies the scale of the label text, default 1.0


<span style="font-weight: normal;"><u>Colour Values</u></span>
==Macro reference==


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Range''.
===DisplayString===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DisplayString'''
|-
| colspan="2" | Displays a string value on the label.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Value
|-
| colspan="2" | Integer value to display&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value


<span style="font-weight: normal;"><u>Foreground Colour</u></span>
===SetForegroundColour===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetForegroundColour'''
|-
| colspan="2" | Allows the user to manually specify the default colour of the foreground text.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | Colour
|-
| colspan="2" | RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


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


The label foreground Text colour
==Property reference==


<span style="font-weight: normal;"><u>Background Colour</u></span>
{| class="mtx-class-macrotable wikitable"
 
|-
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''BgCol''.
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
 
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
The label background Surrounding colour
|-
 
|-
<span style="font-weight: normal;"><u>Value</u></span>
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Title
This property is of type ''Line of text'' and can be referenced with the variable name ''Value1''.
|-
 
|-
''<span style="color:red;">No additional information</span>''
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Show Title
 
|-
 
| colspan="2" | Decides if the title is shown on the panel.&nbsp;
<span style="font-weight: normal;"><u>Foreground Colour</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''FgCol1''.
| width="90%" | Title Text
 
|-
The label foreground Text colour when in the specified range
| colspan="2" | Specifies the title displayed on the panel.&nbsp;
 
|-
<span style="font-weight: normal;"><u>Background Colour</u></span>
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
| width="90%" | Title Scale
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''BgCol1''.
|-
 
| colspan="2" | Specifies the size of the title on the panel, default 1.2 &nbsp;
The label background highlight colour when in the specified range
|-
 
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
<span style="font-weight: normal;"><u>Value</u></span>
| width="90%" | Title Colour
 
|-
This property is of type ''Line of text'' and can be referenced with the variable name ''Value2''.
| colspan="2" | Specifies the colour of the title text&nbsp;
 
|-
''<span style="color:red;">No additional information</span>''
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
| width="90%" | Background Colour
 
|-
 
| colspan="2" | Specifies the background colour of the title text&nbsp;
<span style="font-weight: normal;"><u>Foreground Colour</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''FgCol2''.
| width="90%" | Title Offset
 
|-
The label foreground Text colour when in the specified range
| colspan="2" | Distance above component center to draw the title&nbsp;
 
|-
<span style="font-weight: normal;"><u>Background Colour</u></span>
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Label Properties
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''BgCol2''.
|-
 
|-
The label background highlight colour when in the specified range
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
| width="90%" | Label Scale
<span style="font-weight: normal;"><u>Value</u></span>
|-
 
| colspan="2" | Specifies the scale of the label text, default 1.0&nbsp;
This property is of type ''Line of text'' and can be referenced with the variable name ''Value3''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
''<span style="color:red;">No additional information</span>''
| width="90%" | Colour Values
 
|-
 
| colspan="2" | Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value&nbsp;
 
|-
<span style="font-weight: normal;"><u>Foreground Colour</u></span>
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Defaults
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''FgCol3''.
|-
 
|-
The label foreground Text colour when in the specified range
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
| width="90%" | String Colour
<span style="font-weight: normal;"><u>Background Colour</u></span>
|-
 
| colspan="2" | The label Text colour&nbsp;
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''BgCol3''.
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
The label background highlight colour when in the specified range
| width="90%" class="mtx-class-propfolder" | Value 1
 
|-
<span style="font-weight: normal;"><u>Value</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
This property is of type ''Line of text'' and can be referenced with the variable name ''Value4''.
| width="90%" | Value
 
|-
''<span style="color:red;">No additional information</span>''
| colspan="2" | &nbsp;
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
| width="90%" | String Colour
<span style="font-weight: normal;"><u>Foreground Colour</u></span>
|-
 
| colspan="2" | The label Text colour when in the specified range&nbsp;
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''FgCol4''.
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
The label foreground Text colour when in the specified range
| width="90%" class="mtx-class-propfolder" | Range 2
 
|-
<span style="font-weight: normal;"><u>Background Colour</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''BgCol4''.
| width="90%" | Value
 
|-
The label background highlight colour when in the specified range
| colspan="2" | &nbsp;
 
|-
<span style="font-weight: normal;"><u>Value</u></span>
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
| width="90%" | String Colour
This property is of type ''Line of text'' and can be referenced with the variable name ''Value5''.
|-
 
| colspan="2" | The label Text colour when in the specified range&nbsp;
''<span style="color:red;">No additional information</span>''
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Range 3
 
|-
<span style="font-weight: normal;"><u>Foreground Colour</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''FgCol5''.
| width="90%" | Value
 
|-
The label foreground Text colour when in the specified range
| colspan="2" | &nbsp;
 
|-
<span style="font-weight: normal;"><u>Background Colour</u></span>
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
| width="90%" | String Colour
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''BgCol5''.
|-
 
| colspan="2" | The label Text colour when in the specified range&nbsp;
The label background highlight colour when in the specified range
|-
| 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]]
| width="90%" | Value
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | String Colour
|-
| 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]]
| width="90%" | Value
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | String Colour
|-
| colspan="2" | The label Text colour when in the specified range&nbsp;
|}

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 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_String_Label_(Indicators)&oldid=48362"