Component: Numeric Label (Indicators)

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

DisplayAsInt

	DisplayAsInt
Displays an integer value on the label. Capable of displaying positive and negative values.
- LONG	Value
Integer value to display
- VOID	Return

DisplayAsReal

	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

	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

SetUnits

	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