Jump to content

Component: Numeric Display (Indicators)

From Flowcode Help
Revision as of 08:56, 17 February 2022 by MartinW (talk | contribs) (Examples)
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 Pack

SCADA

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


SetUnits
Allows the user to manually specify the units string that is appended to the end of the label. 
- STRING Units
RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent 
- VOID Return



Property reference

Properties
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 
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 
Foreground Colour
The label foreground Text colour 
Background Colour
The label background Surrounding colour 
Min Value
The minimum value to meet the range condition ( >= )  
Max Value
The maximum value to meet the range condition ( < )  
Foreground Colour
The label foreground Text colour when in the specified range 
Background Colour
The label background highlight colour when in the specified range 
Min Value
The minimum value to meet the range condition ( >= )  
Max Value
The maximum value to meet the range condition ( < )  
Foreground Colour
The label foreground Text colour when in the specified range 
Background Colour
The label background highlight colour when in the specified range 
Min Value
The minimum value to meet the range condition ( >= )  
Max Value
The maximum value to meet the range condition ( < )  
Foreground Colour
The label foreground Text colour when in the specified range 
Background Colour
The label background highlight colour when in the specified range 
Min Value
The minimum value to meet the range condition ( >= )  
Max Value
The maximum value to meet the range condition ( < )  
Foreground Colour
The label foreground Text colour when in the specified range 
Background Colour
The label background highlight colour when in the specified range 
Min Value
The minimum value to meet the range condition ( >= )  
Max Value
The maximum value to meet the range condition ( < )  
Foreground Colour
The label foreground Text colour when in the specified range 
Background Colour
The label background highlight colour when in the specified range 
Connections
Simulations