Component: Numeric Label (Indicators): Difference between revisions

Revision as of 09:59, 27 January 2023

Author	Matrix TSL
Version	1.0
Category	Indicators

Numeric Label component

Allows a numeric label to be displayed on the user panel. 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_NumericLabel.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_NumericLabel.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

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

	SetForegroundColour
Allows the user to manually specify the default colour of the foreground text.
- LONG	Colour
RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent
- 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
	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
	Label Properties
	Label Scale
Specifies the scale of the label text, default 1.0
	Show Units
Specifies if the unit text is appended to the end of the numeric value
	Unit Text
Optionally adds a unit label to the end of the displays string
	Colour Ranges
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value
	Defaults
	Numeric Colour
The label Text 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

	SetForegroundColour
Allows the user to manually specify the default colour of the foreground text.
- LONG	Colour
RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent
- 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
	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
	Label Properties
	Label Scale
Specifies the scale of the label text, default 1.0
	Show Units
Specifies if the unit text is appended to the end of the numeric value
	Unit Text
Optionally adds a unit label to the end of the displays string
	Colour Ranges
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value
	Defaults
	Numeric Colour
The label Text 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

	SetForegroundColour
Allows the user to manually specify the default colour of the foreground text.
- LONG	Colour
RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent
- 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
	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
	Label Properties
	Label Scale
Specifies the scale of the label text, default 1.0
	Show Units
Specifies if the unit text is appended to the end of the numeric value
	Unit Text
Optionally adds a unit label to the end of the displays string
	Colour Ranges
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value
	Defaults
	Numeric Colour
The label Text 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

	SetForegroundColour
Allows the user to manually specify the default colour of the foreground text.
- LONG	Colour
RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent
- 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
	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
	Label Properties
	Label Scale
Specifies the scale of the label text, default 1.0
	Show Units
Specifies if the unit text is appended to the end of the numeric value
	Unit Text
Optionally adds a unit label to the end of the displays string
	Colour Ranges
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value
	Defaults
	Numeric Colour
The label Text colour

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_NumericLabel.fcfx FC_Comp_Source_NumericLabel.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_NumericLabel.fcfx FC_Comp_Source_NumericLabel.fcfx]
 Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_NumericLabel.fcfx FC_Comp_Source_NumericLabel.fcfx]
 ==Detailed description==
@@ Line 32: / Line 34: @@
 ==Examples==
@@ Line 42: / Line 46: @@
 ==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;" | '''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, -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''
+|}
+{| 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''
+|}
+==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;" | Label Properties
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
+| width="90%" | Label Scale
+|-
+| colspan="2" | Specifies the scale of the label text, default 1.0&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Show Units
+|-
+| colspan="2" | Specifies if the unit text is appended to the end of the numeric value&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
+| width="90%" | Unit Text
+|-
+| colspan="2" | Optionally adds a unit label to the end of the displays string&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%" | Numeric Colour
+|-
+| colspan="2" | The label Text colour&nbsp;
+|}==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Wiki bot (talk | contribs)

Revision as of 09:59, 27 January 2023

Numeric Label component

Component Source Code

Detailed description

Examples

Macro reference

Property reference

Property reference

Property reference

Property reference