Difference between revisions of "Component: Numeric Label (Indicators)"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
Line 1: | Line 1: | ||
− | + | {| style="width:50%" | |
− | |||
− | {| | ||
|- | |- | ||
− | | width="20%" style="color: gray;" | Author | + | | width="20%" style="color:gray;" | Author |
| Matrix TSL | | Matrix TSL | ||
|- | |- | ||
− | | width="20%" style="color: gray;" | Version | + | | width="20%" style="color:gray;" | Version |
− | | 1.0 | + | | 1.0 |
|- | |- | ||
− | | width="20%" style="color: gray;" | Category | + | | width="20%" style="color:gray;" | Category |
| Indicators | | 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 Pack== |
− | |||
− | |||
− | |||
− | + | SCADA | |
− | |||
+ | ==Detailed description== | ||
− | + | ''No detailed description exists yet for this component'' | |
− | + | ==Examples== | |
− | |||
− | + | ''<span style="color:red;">No additional examples</span>'' | |
− | |||
− | |||
− | + | ==Downloadable macro reference== | |
− | |||
− | :[[ | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |
− | ::Number of decimal point values to show e.g. 2 = 0.00 | + | |- |
+ | | 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 | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
+ | | width="90%" | Value | ||
+ | |- | ||
+ | | colspan="2" | Real floating point value to display | ||
+ | |- | ||
+ | | 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 | ||
+ | |- | ||
+ | | 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'' | ||
+ | |} | ||
− | '''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. | ||
+ | |- | ||
+ | |- | ||
+ | | 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 | ||
+ | |- | ||
+ | | 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. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG | ||
+ | | width="90%" | Value | ||
+ | |- | ||
+ | | colspan="2" | Integer value to display | ||
+ | |- | ||
+ | | 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. | |
− | + | |- | |
− | + | |- | |
− | : | + | | 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 |
− | + | |- | |
− | + | | 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'' | |
− | + | |} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | = | ||
− | |||
− | |||
− | ''' | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | Allows the user to manually specify the units string that is appended to the end of the label. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | :: | ||
− | |||
− | |||
− | |||
− | |||
− | |||
Line 109: | Line 111: | ||
==Property reference== | ==Property reference== | ||
− | |||
− | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
− | + | |- | |
− | Decides if the title is shown on the panel. | + | | 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" | [[File:Fc9-type-7-icon.png]] | |
− | + | | width="90%" | Show Title | |
− | Specifies the title displayed on the panel. | + | |- |
− | + | | colspan="2" | Decides if the title is shown on the panel. | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | |
− | + | | width="90%" | Title Text | |
− | + | |- | |
− | Specifies the size of the title on the panel, default 1.2 | + | | colspan="2" | Specifies the title displayed on the panel. |
− | + | |- | |
− | + | | 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 | |
− | Specifies the | + | |- |
− | + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | |
− | + | | width="90%" | Title Colour | |
− | + | |- | |
− | + | | colspan="2" | Specifies the colour of the title text | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | + | | width="90%" | Title Offset | |
− | + | |- | |
− | + | | colspan="2" | Distance above component center to draw the title | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | Specifies the scale of the label text, default 1.0 | + | | width="90%" | Label Scale |
− | + | |- | |
− | + | | colspan="2" | Specifies the scale of the label text, default 1.0 | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |
− | + | | width="90%" | Show Units | |
− | Specifies if the unit text is appended to the end of the numeric value | + | |- |
− | + | | colspan="2" | Specifies if the unit text is appended to the end of the numeric value | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | |
− | + | | width="90%" | Unit Text | |
− | + | |- | |
− | Optionally adds a unit label to the end of the displays string | + | | colspan="2" | Optionally adds a unit label to the end of the displays string |
− | + | |- | |
− | + | | 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 | |
− | Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value | + | |- |
− | + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | |
− | + | | width="90%" | Numeric Colour | |
− | + | |- | |
− | + | | colspan="2" | The label Text colour | |
− | + | |- | |
− | The label | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] |
− | + | | width="90%" | Min Value | |
− | + | |- | |
− | + | | colspan="2" | The minimum value to meet the range condition ( >= ) | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | + | | width="90%" | Max Value | |
− | + | |- | |
− | + | | colspan="2" | The maximum value to meet the range condition ( < ) | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | |
− | + | | width="90%" | Numeric Colour | |
− | The minimum value to meet the range condition ( >= ) | + | |- |
− | + | | colspan="2" | The label Text colour when in the specified range | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | + | | width="90%" | Min Value | |
− | + | |- | |
− | The maximum value to meet the range condition ( < ) | + | | colspan="2" | The minimum value to meet the range condition ( >= ) |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | + | | width="90%" | Max Value | |
− | + | |- | |
− | + | | colspan="2" | The maximum value to meet the range condition ( < ) | |
− | The label | + | |- |
− | + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | |
− | + | | width="90%" | Numeric Colour | |
− | + | |- | |
− | + | | colspan="2" | The label Text colour when in the specified range | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | + | | width="90%" | Min Value | |
− | + | |- | |
− | + | | colspan="2" | The minimum value to meet the range condition ( >= ) | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | The minimum value to meet the range condition ( >= ) | + | | width="90%" | Max Value |
− | + | |- | |
− | + | | colspan="2" | The maximum value to meet the range condition ( < ) | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | |
− | + | | width="90%" | Numeric Colour | |
− | The maximum value to meet the range condition ( < ) | + | |- |
− | + | | colspan="2" | The label Text colour when in the specified range | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | + | | width="90%" | Min Value | |
− | + | |- | |
− | The label | + | | colspan="2" | The minimum value to meet the range condition ( >= ) |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | + | | width="90%" | Max Value | |
− | + | |- | |
− | + | | colspan="2" | The maximum value to meet the range condition ( < ) | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | |
− | + | | width="90%" | Numeric Colour | |
− | + | |- | |
− | + | | colspan="2" | The label Text colour when in the specified range | |
− | + | |- | |
− | The minimum value to meet the range condition ( >= ) | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] |
− | + | | width="90%" | Min Value | |
− | + | |- | |
− | + | | colspan="2" | The minimum value to meet the range condition ( >= ) | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
− | The maximum value to meet the range condition ( < ) | + | | width="90%" | Max Value |
− | + | |- | |
− | + | | colspan="2" | The maximum value to meet the range condition ( < ) | |
− | + | |- | |
− | + | | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | |
− | + | | width="90%" | Numeric Colour | |
− | The label | + | |- |
− | + | | colspan="2" | The label Text colour when in the specified range | |
− | + | |- | |
− | + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]] | |
− | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections''' | |
− | + | |- | |
− | + | |- | |
− | + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]] | |
− | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations''' | |
− | + | |- | |
− | + | |} | |
− | |||
− | The minimum value to meet the range condition ( >= ) | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | The maximum value to meet the range condition ( < ) | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | The label | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | The minimum value to meet the range condition ( >= ) | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | The maximum value to meet the range condition ( < ) | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | The label | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Revision as of 16:22, 7 January 2022
Author | Matrix TSL |
Version | 1.0 |
Category | Indicators |
Contents
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 Pack
SCADA
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
![]() |
SetForegroundColour |
Allows the user to manually specify the default colour of the foreground text. | |
![]() |
Colour |
RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent | |
![]() |
Return |
![]() |
DisplayAsInt |
Displays an integer value on the label. Capable of displaying positive and negative values. | |
![]() |
Value |
Integer value to display | |
![]() |
Return |
![]() |
SetUnits |
Allows the user to manually specify the units string that is appended to the end of the label. | |
![]() |
Units |
RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent | |
![]() |
Return |