Difference between revisions of "Component: String Label (Indicators)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
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 Pack==
−
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==
+
SCADA
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
+
''No detailed description exists yet for this component''
  
−
''This component does not contain any downloadable macros''
+
==Examples==
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>DisplayString</tt></u></span>===
+
''<span style="color:red;">No additional examples</span>''
−
Displays a string value on the label.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|<- STRING]] ''Value''
+
==Downloadable macro reference==
−
::Integer value to display
 
−
::''This parameter may be returned back to the caller''
 
  
 +
{| 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.&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''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
===<span style="font-weight: normal;"><u><tt>SetBackgroundColour</tt></u></span>===
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetForegroundColour'''
−
Allows the user to manually specify the default colour of the background.
+
|-
−
 
+
| colspan="2" | Allows the user to manually specify the default colour of the foreground text.&nbsp;
−
'''Parameters'''
+
|-
−
 
+
|-
−
:[[Variable Types|LONG]] ''Colour''
+
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
−
::RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent
+
| width="90%" | Colour
−
 
+
|-
−
 
+
| colspan="2" | RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent&nbsp;
−
'''Return value'''
+
|-
−
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
:''This call does not return a value''
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
−
 
+
|}
−
 
 
−
===<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''
 
  
  
Line 76: Line 70:
  
 
==Property reference==
 
==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''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Decides if the title is shown on the panel.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<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''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Show Title
−
Specifies the title displayed on the panel.
+
|-
−
 
+
| colspan="2" | Decides if the title is shown on the panel.&nbsp;
−
<span style="font-weight: normal;"><u>Title Scale</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''TitleScale''.
+
| width="90%" | Title Text
−
 
+
|-
−
Specifies the size of the title on the panel, default 1.2
+
| colspan="2" | Specifies the title displayed on the panel.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Foreground 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 ''FgColTitle''.
+
|-
−
 
+
| colspan="2" | Specifies the size of the title on the panel, default 1.2 &nbsp;
−
Specifies the foreground colour of the title text
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
<span style="font-weight: normal;"><u>Background Colour</u></span>
+
| width="90%" | Title Colour
−
 
+
|-
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''BgColTitle''.
+
| colspan="2" | Specifies the colour of the title text&nbsp;
−
 
+
|-
−
Specifies the background colour of the title text
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
 
+
| width="90%" | Background Colour
−
<span style="font-weight: normal;"><u>Label Scale</u></span>
+
|-
−
 
+
| colspan="2" | Specifies the background colour of the title text&nbsp;
−
This property is of type ''Floating point'' and can be referenced with the variable name ''LabelScale''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
Specifies the scale of the label text, default 1.0
+
| width="90%" | Title Offset
−
 
+
|-
−
<span style="font-weight: normal;"><u>Colour Values</u></span>
+
| colspan="2" | Distance above component center to draw the title&nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Range''.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Label Scale
−
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value
+
|-
−
 
+
| colspan="2" | Specifies the scale of the label text, default 1.0&nbsp;
−
<span style="font-weight: normal;"><u>Foreground Colour</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''FgCol''.
+
| width="90%" | Colour Values
−
 
+
|-
−
The label foreground Text colour
+
| 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>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 ''BgCol''.
+
|-
−
 
+
| colspan="2" | The label Text colour&nbsp;
−
The label background Surrounding colour
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
<span style="font-weight: normal;"><u>Value</u></span>
+
| width="90%" | Value
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Value1''.
+
| colspan="2" | &nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| 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;
−
<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%" | 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 ''BgCol1''.
+
|-
−
 
+
| 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" | [[File:Fc9-type-10-icon.png]]
−
<span style="font-weight: normal;"><u>Value</u></span>
+
| width="90%" | Value
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Value2''.
+
| colspan="2" | &nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| 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;
−
<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 ''FgCol2''.
+
| 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 ''BgCol2''.
+
|-
−
 
+
| 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" | [[File:Fc9-type-10-icon.png]]
−
<span style="font-weight: normal;"><u>Value</u></span>
+
| width="90%" | Value
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Value3''.
+
| colspan="2" | &nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| 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;
−
<span style="font-weight: normal;"><u>Foreground Colour</u></span>
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''FgCol3''.
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
−
 
+
|-
−
The label foreground Text colour when in the specified range
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
<span style="font-weight: normal;"><u>Background Colour</u></span>
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
−
 
+
|-
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''BgCol3''.
+
|}
−
 
 
−
The label background highlight colour when in the specified range
 
−
 
 
−
<span style="font-weight: normal;"><u>Value</u></span>
 
−
 
 
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Value4''.
 
−
 
 
−
''<span style="color:red;">No additional information</span>''
 
−
 
 
−
 
 
−
 
 
−
<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 ''FgCol4''.
 
−
 
 
−
The label foreground Text colour when in the specified range
 
−
 
 
−
<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 ''BgCol4''.
 
−
 
 
−
The label background highlight colour when in the specified range
 
−
 
 
−
<span style="font-weight: normal;"><u>Value</u></span>
 
−
 
 
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Value5''.
 
−
 
 
−
''<span style="color:red;">No additional information</span>''
 
−
 
 
−
 
 
−
 
 
−
<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 ''FgCol5''.
 
−
 
 
−
The label foreground Text colour when in the specified range
 
−
 
 
−
<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 ''BgCol5''.
 
−
 
 
−
The label background highlight colour when in the specified range
 

Revision as of 16:22, 7 January 2022

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 Pack

SCADA

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png DisplayString
Displays a string value on the label. 
Fc9-string-icon.png - STRING Value
Integer value to display 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetForegroundColour
Allows the user to manually specify the default colour of the foreground text. 
Fc9-s32-icon.png - LONG Colour
RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Show Title
Decides if the title is shown on the panel. 
Fc9-type-10-icon.png Title Text
Specifies the title displayed on the panel. 
Fc9-type-15-icon.png Title Scale
Specifies the size of the title on the panel, default 1.2  
Fc9-type-2-icon.png Title Colour
Specifies the colour of the title text 
Fc9-type-2-icon.png Background Colour
Specifies the background colour of the title text 
Fc9-type-15-icon.png Title Offset
Distance above component center to draw the title 
Fc9-type-15-icon.png Label Scale
Specifies the scale of the label text, default 1.0 
Fc9-type-16-icon.png Colour Values
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value 
Fc9-type-2-icon.png String Colour
The label Text colour 
Fc9-type-10-icon.png Value
 
Fc9-type-2-icon.png String Colour
The label Text colour when in the specified range 
Fc9-type-10-icon.png Value
 
Fc9-type-2-icon.png String Colour
The label Text colour when in the specified range 
Fc9-type-10-icon.png Value
 
Fc9-type-2-icon.png String Colour
The label Text colour when in the specified range 
Fc9-type-10-icon.png Value
 
Fc9-type-2-icon.png String Colour
The label Text colour when in the specified range 
Fc9-type-10-icon.png Value
 
Fc9-type-2-icon.png String Colour
The label Text colour when in the specified range 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_String_Label_(Indicators)&oldid=27753"