Component: Numeric Label (Indicators)

From Flowcode Help
Revision as of 13:12, 7 February 2023 by Wiki bot (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
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

Fc9-comp-macro.png DisplayAsInt
Displays an integer value on the label. Capable of displaying positive and negative values. 
Fc9-s32-icon.png - LONG Value
Integer value to display 
Fc9-void-icon.png - VOID Return


DisplayAsReal

Fc9-comp-macro.png DisplayAsReal
Displays a floating point value on the label with a confiiguarable number of decimal points 
Fc9-f32-icon.png - FLOAT Value
Real floating point value to display 
Fc9-u8-icon.png - BYTE Precision
Number of decimal point values to show e.g. 2 = 0.00 
Fc9-void-icon.png - VOID Return


SetForegroundColour

Fc9-comp-macro.png SetForegroundColour
Allows the user to manually specify the default colour of the foreground text. 
Fc9-s32-icon.png - LONG Colour
RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent 
Fc9-void-icon.png - VOID Return


SetUnits

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


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Title
Fc9-type-7-icon.png Show Title
Decides if the title is shown on the panel. 
Fc9-type-10-icon.png Title Text
Specifies the title displayed on the panel. 
Fc9-type-15-icon.png Title Scale
Specifies the size of the title on the panel, default 1.2  
Fc9-type-2-icon.png Title Colour
Specifies the colour of the title text 
Fc9-type-15-icon.png Title Offset
Distance above component center to draw the title 
Fc9-conn-icon.png Label Properties
Fc9-type-15-icon.png Label Scale
Specifies the scale of the label text, default 1.0 
Fc9-type-7-icon.png Show Units
Specifies if the unit text is appended to the end of the numeric value 
Fc9-type-10-icon.png Unit Text
Optionally adds a unit label to the end of the displays string 
Fc9-type-16-icon.png Colour Ranges
Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value 
Fc9-conn-icon.png Defaults
Fc9-type-2-icon.png Numeric Colour
The label Text colour