Jump to content

Component: Numeric Display (Indicators): Difference between revisions

From Flowcode Help
No edit summary
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 for the component source code: [https://www.flowcode.co.uk/wikicopy/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''


==Examples==
==Examples==


An example of a numeric display changing colour set out within the display properties
An example of a numeric display changing colour set out within the display properties
Line 103: Line 107:
|-
|-
| colspan="2" | Integer value to display 
| 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;" | '''SetUnits'''
|-
| colspan="2" | Allows the user to manually specify the units string that is appended to the end of the label. 
|-
|-
| 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 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 135: Line 121:
| 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 161: Line 151:
|-
|-
| 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;" | Display Properties
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Line 171: Line 165:
|-
|-
| 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 181: Line 179:
|-
|-
| colspan="2" | The label background Surrounding colour 
| colspan="2" | The label background Surrounding colour 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Min Value
|-
| colspan="2" | The minimum value to meet the range condition ( >= )  
|-
| 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'''
|-
|}
|}

Revision as of 17:44, 9 November 2022

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 for the component source code: 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

Downloadable macro reference

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
Allows the user to manually specify the default colour of the background. 
- LONG Colour
RGB colour in the hexadecimal form 0xBBGGRR 
- 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 
- VOID Return


DisplayAsInt
Displays an integer value on the label. Capable of displaying positive and negative values. 
- LONG Value
Integer value to display 
- 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