Difference between revisions of "Component: String Label (Indicators)"
From Flowcode Help
Jump to navigationJump to search| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 75: | Line 79: | ||
| 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;" | Title | ||
|- | |- | ||
|- | |- | ||
| Line 106: | Line 114: | ||
|- | |- | ||
| colspan="2" | Distance above component center to draw the title | | 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="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| Line 116: | Line 128: | ||
|- | |- | ||
| colspan="2" | Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value | | 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="10%" align="center" | [[File:Fc9-type-2-icon.png]] | ||
| Line 121: | Line 137: | ||
|- | |- | ||
| colspan="2" | The label Text 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="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| Line 131: | Line 151: | ||
|- | |- | ||
| colspan="2" | The label Text colour when in the specified range | | 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="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| Line 141: | Line 165: | ||
|- | |- | ||
| colspan="2" | The label Text colour when in the specified range | | 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="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| Line 151: | Line 179: | ||
|- | |- | ||
| colspan="2" | The label Text colour when in the specified range | | 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="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| Line 161: | Line 193: | ||
|- | |- | ||
| colspan="2" | The label Text colour when in the specified range | | 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="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| Line 171: | Line 207: | ||
|- | |- | ||
| colspan="2" | The label Text colour when in the specified range | | colspan="2" | The label Text colour when in the specified range | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Latest revision as of 17:22, 9 November 2022
| 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 Pack
SCADA
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable 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 | |
