Jump to content

Component: String Label (Indicators): Difference between revisions

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
No edit summary
No edit summary
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/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 30: Line 32:


==Examples==
==Examples==




Line 42: Line 46:


==Macro reference==
==Macro reference==
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayString'''
|-
| colspan="2" | Displays a string value on the label. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Value
|-
| colspan="2" | Integer value to display 
|-
| 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''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetForegroundColour'''
|-
| colspan="2" | Allows the user to manually specify the default colour of the foreground text. 
|-
|-
| 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 
|-
| 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''
|}
==Property reference==
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Title
|-
|-
| 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. 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title Text
|-
| colspan="2" | Specifies the title displayed on the panel. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Title Scale
|-
| colspan="2" | Specifies the size of the title on the panel, default 1.2  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Title Colour
|-
| colspan="2" | Specifies the colour of the title text 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| colspan="2" | Specifies the background colour of the title text 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Title Offset
|-
| colspan="2" | Distance above component center to draw the title 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Label Scale
|-
| colspan="2" | Specifies the scale of the label text, default 1.0 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Colour Values
|-
| colspan="2" | Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Defaults
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | String Colour
|-
| colspan="2" | The label Text colour 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Value 1
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Value
|-
| colspan="2" |  
|-
| 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 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Range 2
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Value
|-
| colspan="2" |  
|-
| 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 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Range 3
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Value
|-
| colspan="2" |  
|-
| 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 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Range 4
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Value
|-
| colspan="2" |  
|-
| 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 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Range 5
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Value
|-
| colspan="2" |  
|-
| 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 
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:17, 20 January 2023

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 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
Displays a string value on the label. 
- STRING Value
Integer value to display 
- VOID Return


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 

==Macro reference==

DisplayString
Displays a string value on the label. 
- STRING Value
Integer value to display 
- VOID Return


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=32948"