Component: Numeric Display (Indicators)
| Author | Matrix TSL |
| Version | 1.0 (Release) |
| Category | Indicators |
Contents
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.
Examples
No additional examples
Downloadable macro reference
This component does not contain any downloadable macros
Simulation macro reference
DisplayAsReal
Displays a floating point value on the label with a confiiguarable number of decimal points
Parameters
- FLOAT Value
- Real floating point value to display
- BYTE Precision
- Number of decimal point values to show e.g. 2 = 0.00
Return value
- This call does not return a value
SetBackgroundColour
Allows the user to manually specify the default colour of the background.
Parameters
- LONG Colour
- RGB colour in the hexadecimal form 0xBBGGRR
Return value
- This call does not return a value
DisplayAsInt
Displays an integer value on the label.
Capable of displaying positive and negative values.
Parameters
- LONG Value
- Integer value to display
Return value
- This call does not return a value
SetForegroundColour
Allows the user to manually specify the default colour of the foreground text.
Parameters
- LONG Colour
- RGB colour in the hexadecimal form 0xBBGGRR
Return value
- This call does not return a value
SetUnits
Allows the user to manually specify the units string that is appended to the end of the label.
Parameters
- <- STRING Units
- RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent
- This parameter may be returned back to the caller
Return value
- This call does not return a value
Property reference
Show Title
This property is of type True or false and can be referenced with the variable name ShowTitle.
Decides if the title is shown on the panel.
Title Text
This property is of type Line of text and can be referenced with the variable name Title.
Specifies the title displayed on the panel.
Title Scale
This property is of type Floating point and can be referenced with the variable name TitleScale.
Specifies the size of the title on the panel, default 1.2
Foreground Colour
This property is of type Color picker with transparency and can be referenced with the variable name FgColTitle.
Specifies the foreground colour of the title text
Background Colour
This property is of type Color picker with transparency and can be referenced with the variable name BgColTitle.
Specifies the background colour of the title text
Number of Digits
This property is of type Fixed list of ints and can be referenced with the variable name NumDigits.
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
This property is of type Fixed list of ints and can be referenced with the variable name Range.
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value
Foreground Colour
This property is of type Color picker with transparency and can be referenced with the variable name FgCol.
The label foreground Text colour
Background Colour
This property is of type Color picker with transparency and can be referenced with the variable name BgCol.
The label background Surrounding colour
Min Value
This property is of type Floating point and can be referenced with the variable name MinVal1.
The minimum value to meet the range condition ( >= )
Max Value
This property is of type Floating point and can be referenced with the variable name MaxVal1.
The maximum value to meet the range condition ( < )
Foreground Colour
This property is of type Color picker with transparency and can be referenced with the variable name FgCol1.
The label foreground Text colour when in the specified range
Background Colour
This property is of type Color picker with transparency and can be referenced with the variable name BgCol1.
The label background highlight colour when in the specified range
Min Value
This property is of type Floating point and can be referenced with the variable name MinVal2.
The minimum value to meet the range condition ( >= )
Max Value
This property is of type Floating point and can be referenced with the variable name MaxVal2.
The maximum value to meet the range condition ( < )
Foreground Colour
This property is of type Color picker with transparency and can be referenced with the variable name FgCol2.
The label foreground Text colour when in the specified range
Background Colour
This property is of type Color picker with transparency and can be referenced with the variable name BgCol2.
The label background highlight colour when in the specified range
Min Value
This property is of type Floating point and can be referenced with the variable name MinVal3.
The minimum value to meet the range condition ( >= )
Max Value
This property is of type Floating point and can be referenced with the variable name MaxVal3.
The maximum value to meet the range condition ( < )
Foreground Colour
This property is of type Color picker with transparency and can be referenced with the variable name FgCol3.
The label foreground Text colour when in the specified range
Background Colour
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
Min Value
This property is of type Floating point and can be referenced with the variable name MinVal4.
The minimum value to meet the range condition ( >= )
Max Value
This property is of type Floating point and can be referenced with the variable name MaxVal4.
The maximum value to meet the range condition ( < )
Foreground Colour
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
Background Colour
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
Min Value
This property is of type Floating point and can be referenced with the variable name MinVal5.
The minimum value to meet the range condition ( >= )
Max Value
This property is of type Floating point and can be referenced with the variable name MaxVal5.
The maximum value to meet the range condition ( < )
Foreground Colour
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
Background Colour
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
