Difference between revisions of "Component: Indicator Meter (Indicators)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| 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.5 (Development)
+
| 1.5
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Indicators
 
| Indicators
 
|}
 
|}
  
  
 +
==Indicator Meter component==
 +
Square analogue panel meter. A simulation only component - the needle value is set solely by the 'SetValue' macro.
  
−
==[[File:Component Icon 3705f53b_93ce_4fa7_8947_0b67f098022d.png|Image]] Indicator Meter component==
+
==Component Pack==
−
Square analogue panel meter.
 
−
A simulation only component - the needle value is set solely by the 'SetValue' macro.
 
  
−
==Examples==
+
SCADA
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
+
''No detailed description exists yet for this component''
  
−
''This component does not contain any downloadable macros''
+
==Examples==
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
+
''<span style="color:red;">No additional examples</span>''
−
Set the meter needle to a new position based on the current scaling properties.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|FLOAT]] ''Value''
+
==Downloadable macro reference==
−
::Needle position between min and max
 
  
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
'''Return value'''
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
:''This call does not return a value''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
 +
|-
 +
| colspan="2" | Set the meter needle to a new position based on the current scaling properties.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | Needle position between min and max&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''
 +
|}
  
  
Line 46: Line 52:
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Minimum</u></span>
 
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''val_min''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Minimum value to show on the meter.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Maximum</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''val_max''.
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Minimum
−
Maximum value to show on the meter.
+
|-
−
 
+
| colspan="2" | Minimum value to show on the meter.&nbsp;
−
<span style="font-weight: normal;"><u>BG Color</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''bg_color''.
+
| width="90%" | Maximum
−
 
+
|-
−
Color of the meter scale background.
+
| colspan="2" | Maximum value to show on the meter.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Positive Color</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
 
+
| width="90%" | BG Color
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ink_color''.
+
|-
−
 
+
| colspan="2" | Color of the meter scale background.&nbsp;
−
Color of the scale gradations for positive values.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
<span style="font-weight: normal;"><u>Negative Color</u></span>
+
| width="90%" | Positive Color
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''neg_color''.
+
| colspan="2" | Color of the scale gradations for positive values.&nbsp;
−
 
+
|-
−
Color of the scale gradations for negative values.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Negative Color
−
<span style="font-weight: normal;"><u>Pointer Color</u></span>
+
|-
−
 
+
| colspan="2" | Color of the scale gradations for negative values.&nbsp;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''NeedleColor''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Pointer Color
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Label Color</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Label Color
−
This property is of type ''Color picker'' and can be referenced with the variable name ''label_color''.
+
|-
−
 
+
| colspan="2" | Color of the meter's title label.&nbsp;
−
Color of the meter's title label.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Divisions</u></span>
+
| width="90%" | Divisions
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_count''.
+
| colspan="2" | Number of large scale divisions..&nbsp;
−
 
+
|-
−
Number of large scale divisions..
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Subdivisions
−
<span style="font-weight: normal;"><u>Subdivisions</u></span>
+
|-
−
 
+
| colspan="2" | Number of sub-divisions in between each major division.&nbsp;
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_subdiv''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Number of sub-divisions in between each major division.
+
| width="90%" | Show
−
 
+
|-
−
<span style="font-weight: normal;"><u>Show</u></span>
+
| colspan="2" | Show or hide the scale markings.&nbsp;
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_marks''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Decimals
−
Show or hide the scale markings.
+
|-
−
 
+
| colspan="2" | Number of decimal points to show on scale values.&nbsp;
−
<span style="font-weight: normal;"><u>Decimals</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''dec_places''.
+
| width="90%" | Text Size %
−
 
+
|-
−
Number of decimal points to show on scale values.
+
| colspan="2" | Text height of the scale values.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Text Size %</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
−
 
+
| width="90%" | Font
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''num_size''.
+
|-
−
 
+
| colspan="2" | Font for the scale value numbers.&nbsp;
−
Text height of the scale values.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Font</u></span>
+
| width="90%" | Show
−
 
+
|-
−
This property is of type ''Font picker'' and can be referenced with the variable name ''num_font''.
+
| colspan="2" | Show or hide the scale number values.&nbsp;
−
 
+
|-
−
Font for the scale value numbers.
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Text
−
<span style="font-weight: normal;"><u>Show</u></span>
+
|-
−
 
+
| colspan="2" | A title label to make the meter easier to identify.&nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_numbers''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Show or hide the scale number values.
+
| width="90%" | Text Size %
−
 
+
|-
−
<span style="font-weight: normal;"><u>Text</u></span>
+
| colspan="2" | Height of the label text.&nbsp;
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label_text''.
+
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
−
 
+
| width="90%" | Font
−
A title label to make the meter easier to identify.
+
|-
−
 
+
| colspan="2" | Font for printing the label.&nbsp;
−
<span style="font-weight: normal;"><u>Text Size %</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''label_size''.
+
| width="90%" | Show
−
 
+
|-
−
Height of the label text.
+
| colspan="2" | Show or hide the title label.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Font</u></span>
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
−
This property is of type ''Font picker'' and can be referenced with the variable name ''label_font''.
+
|-
−
 
+
|-
−
Font for printing the label.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
−
<span style="font-weight: normal;"><u>Show</u></span>
+
|-
−
 
+
|}
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_label''.
 
−
 
 
−
Show or hide the title label.
 

Revision as of 16:22, 7 January 2022

Author Matrix TSL
Version 1.5
Category Indicators


Indicator Meter component

Square analogue panel meter. A simulation only component - the needle value is set solely by the 'SetValue' macro.

Component Pack

SCADA

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png SetValue
Set the meter needle to a new position based on the current scaling properties. 
Fc9-f32-icon.png - FLOAT Value
Needle position between min and max 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-15-icon.png Minimum
Minimum value to show on the meter. 
Fc9-type-15-icon.png Maximum
Maximum value to show on the meter. 
Fc9-type-2-icon.png BG Color
Color of the meter scale background. 
Fc9-type-1-icon.png Positive Color
Color of the scale gradations for positive values. 
Fc9-type-1-icon.png Negative Color
Color of the scale gradations for negative values. 
Fc9-type-1-icon.png Pointer Color
 
Fc9-type-1-icon.png Label Color
Color of the meter's title label. 
Fc9-type-14-icon.png Divisions
Number of large scale divisions.. 
Fc9-type-14-icon.png Subdivisions
Number of sub-divisions in between each major division. 
Fc9-type-7-icon.png Show
Show or hide the scale markings. 
Fc9-type-14-icon.png Decimals
Number of decimal points to show on scale values. 
Fc9-type-14-icon.png Text Size %
Text height of the scale values. 
Fc9-type-3-icon.png Font
Font for the scale value numbers. 
Fc9-type-7-icon.png Show
Show or hide the scale number values. 
Fc9-type-10-icon.png Text
A title label to make the meter easier to identify. 
Fc9-type-14-icon.png Text Size %
Height of the label text. 
Fc9-type-3-icon.png Font
Font for printing the label. 
Fc9-type-7-icon.png Show
Show or hide the title label. 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Indicator_Meter_(Indicators)&oldid=27736"