Component: Numeric Display (Indicators): Difference between revisions

Revision as of 15:19, 20 January 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

Basic Numeric Display Example

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

==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

==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

@@ Line 16: / Line 16: @@
 ==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/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==
@@ Line 32: / Line 36: @@
 ==Examples==
@@ Line 47: / Line 53: @@
 ==Macro reference==
+{| 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;" | '''DisplayAsReal'''
+|-
+| colspan="2" | Displays a floating point value on the label with a confiiguarable number of decimal points&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Value
+|-
+| colspan="2" | Real floating point value to display&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Precision
+|-
+| colspan="2" | Number of decimal point values to show e.g. 2 = 0.00&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;" | '''SetBackgroundColour'''
+|-
+| colspan="2" | Allows the user to manually specify the default colour of the background.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | Colour
+|-
+| colspan="2" | RGB colour in the hexadecimal form 0xBBGGRR&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;" | '''SetForegroundColour'''
+|-
+| colspan="2" | Allows the user to manually specify the default colour of the foreground text.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | Colour
+|-
+| colspan="2" | RGB colour in the hexadecimal form 0xBBGGRR&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;" | '''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''
+|}
+==Property reference==
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| 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
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Show Title
+|-
+| colspan="2" | Decides if the title is shown on the panel.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
+| width="90%" | Title Text
+|-
+| colspan="2" | Specifies the title displayed on the panel.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
+| width="90%" | Title Scale
+|-
+| colspan="2" | Specifies the size of the title on the panel, default 1.2 &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
+| width="90%" | Title Colour
+|-
+| colspan="2" | Specifies the colour of the title text&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
+| width="90%" | Title Offset
+|-
+| 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="90%" | Number of Digits
+|-
+| colspan="2" | 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 - - - -&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Colour Ranges
+|-
+| 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="90%" | Foreground Colour
+|-
+| colspan="2" | The label foreground Text colour&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
+| width="90%" | Background Colour
+|-
+| colspan="2" | The label background Surrounding colour&nbsp;
+|}==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Wiki bot (talk | contribs)

Revision as of 15:19, 20 January 2023

Numeric Display component

Component Source Code

Detailed description

Examples

Macro reference

Property reference

Property reference

Property reference