Difference between revisions of "Component: Numeric Display (Indicators)"

From Flowcode Help
Jump to navigationJump to search
 
(12 intermediate revisions by 2 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==
 
  
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
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="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;" | '''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''
 +
|}
 +
 +
 +
===DisplayAsReal===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 54: Line 119:
  
  
 +
===SetBackgroundColour===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 72: Line 138:
  
  
 +
===SetForegroundColour===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 88: Line 155:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| 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;" | '''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;"
 
−
|-
 
−
| 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" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
  
  
Line 134: Line 163:
 
| 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 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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" 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 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 13:08, 7 February 2023

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


FC6 Icon.png Basic Numeric Display Example






Macro reference

DisplayAsInt

Fc9-comp-macro.png DisplayAsInt
Displays an integer value on the label. Capable of displaying positive and negative values. 
Fc9-s32-icon.png - LONG Value
Integer value to display 
Fc9-void-icon.png - VOID Return


DisplayAsReal

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


SetBackgroundColour

Fc9-comp-macro.png SetBackgroundColour
Allows the user to manually specify the default colour of the background. 
Fc9-s32-icon.png - LONG Colour
RGB colour in the hexadecimal form 0xBBGGRR 
Fc9-void-icon.png - VOID Return


SetForegroundColour

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 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Title
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-15-icon.png Title Offset
Distance above component center to draw the title 
Fc9-conn-icon.png Display Properties
Fc9-type-16-icon.png 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 - - - - 
Fc9-type-16-icon.png Colour Ranges
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value 
Fc9-conn-icon.png Defaults
Fc9-type-2-icon.png Foreground Colour
The label foreground Text colour 
Fc9-type-2-icon.png Background Colour
The label background Surrounding colour 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Numeric_Display_(Indicators)&oldid=37767"