Jump to content

Component: Numeric Display (Indicators): Difference between revisions

From Flowcode Help
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(18 intermediate revisions by 3 users not shown)
Line 15: Line 15:
Allows a numeric value to be displayed on the user panel using virtual 7 seg displays. 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.
Allows a numeric value to be displayed on the user panel using virtual 7 seg displays. 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_7SegNumeric.fcfx FC_Comp_Source_7SegNumeric.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_7SegNumeric.fcfx FC_Comp_Source_7SegNumeric.fcfx]


==Detailed description==
==Detailed description==


''No detailed description exists yet for this component''
''No detailed description exists yet for this component''
Line 26: Line 44:




''<span style="color:red;">No additional examples</span>''




==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
 
 
 
An example of a numeric display changing colour set out within the display properties
 
 
{{Fcfile|Basic Numeric Display.fcfx|Basic Numeric Display Example}}
 
 
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===DisplayAsInt===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DisplayAsInt'''
|-
| colspan="2" | Displays an integer value on the label. Capable of displaying positive and negative values.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
|-
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayAsReal'''
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| 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''
|}
 
 
===DisplayAsReal===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DisplayAsReal'''
|-
|-
| colspan="2" | Displays a floating point value on the label with a confiiguarable number of decimal points&nbsp;
| colspan="2" | Displays a floating point value on the label with a confiiguarable number of decimal points&nbsp;
Line 54: Line 119:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetBackgroundColour===
{| 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;" | '''SetBackgroundColour'''
| width="90%" class="mtx-class-macrohead" | '''SetBackgroundColour'''
|-
|-
| colspan="2" | Allows the user to manually specify the default colour of the background.&nbsp;
| colspan="2" | Allows the user to manually specify the default colour of the background.&nbsp;
Line 72: Line 138:




{| 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;
| colspan="2" | Allows the user to manually specify the default colour of the foreground text.&nbsp;
Line 90: Line 157:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
==Property reference==
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayAsInt'''
|-
| colspan="2" | Displays an integer value on the label. Capable of displaying positive and negative values.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| 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''
|}
 


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetUnits'''
|-
| colspan="2" | Allows the user to manually specify the units string that is appended to the end of the label.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Units
|-
|-
| colspan="2" | RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent&nbsp;
| 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="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="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
| width="90%" class="mtx-class-propfolder" | Title
|-
|-
|-
|-
Line 160: Line 193:
|-
|-
| colspan="2" | Distance above component center to draw the title&nbsp;
| 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" | Display Properties
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Line 170: Line 207:
|-
|-
| colspan="2" | Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value&nbsp;
| 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]]
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
Line 180: Line 221:
|-
|-
| colspan="2" | The label background Surrounding colour&nbsp;
| colspan="2" | The label background Surrounding colour&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Min Value
|-
| colspan="2" | The minimum value to meet the range condition ( >= ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Value
|-
| colspan="2" | The maximum value to meet the range condition ( < ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Foreground Colour
|-
| colspan="2" | The label foreground Text colour when in the specified range&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| colspan="2" | The label background highlight colour when in the specified range&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Min Value
|-
| colspan="2" | The minimum value to meet the range condition ( >= ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Value
|-
| colspan="2" | The maximum value to meet the range condition ( < ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Foreground Colour
|-
| colspan="2" | The label foreground Text colour when in the specified range&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| colspan="2" | The label background highlight colour when in the specified range&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Min Value
|-
| colspan="2" | The minimum value to meet the range condition ( >= ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Value
|-
| colspan="2" | The maximum value to meet the range condition ( < ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Foreground Colour
|-
| colspan="2" | The label foreground Text colour when in the specified range&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| colspan="2" | The label background highlight colour when in the specified range&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Min Value
|-
| colspan="2" | The minimum value to meet the range condition ( >= ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Value
|-
| colspan="2" | The maximum value to meet the range condition ( < ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Foreground Colour
|-
| colspan="2" | The label foreground Text colour when in the specified range&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| colspan="2" | The label background highlight colour when in the specified range&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Min Value
|-
| colspan="2" | The minimum value to meet the range condition ( >= ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Value
|-
| colspan="2" | The maximum value to meet the range condition ( < ) &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Foreground Colour
|-
| colspan="2" | The label foreground Text colour when in the specified range&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background Colour
|-
| colspan="2" | The label background highlight 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'''
|-
|}
|}

Latest revision as of 14:37, 13 July 2026

Author Matrix TSL
Version 1.0
Category Indicators


Numeric Display component

Allows a numeric value to be displayed on the user panel using virtual 7 seg displays. 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_7SegNumeric.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_7SegNumeric.fcfx

Detailed description

No detailed description exists yet for this component

Examples

An example of a numeric display changing colour set out within the display properties


Basic Numeric Display Example






Macro reference

DisplayAsInt

DisplayAsInt
Displays an integer value on the label. Capable of displaying positive and negative values. 
- LONG Value
Integer value to display 
- VOID Return


DisplayAsReal

DisplayAsReal
Displays a floating point value on the label with a confiiguarable number of decimal points 
- FLOAT Value
Real floating point value to display 
- BYTE Precision
Number of decimal point values to show e.g. 2 = 0.00 
- VOID Return


SetBackgroundColour

SetBackgroundColour
Allows the user to manually specify the default colour of the background. 
- LONG Colour
RGB colour in the hexadecimal form 0xBBGGRR 
- 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 
- 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 
Title Offset
Distance above component center to draw the title 
Display Properties
Number of Digits
Number of digits in the indicator. The number of digits sets the range available For example 4 Digits can display 0000 to 9999, out of range items will be shown as - - - - 
Colour Ranges
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value 
Defaults
Foreground Colour
The label foreground Text colour 
Background Colour
The label background Surrounding colour