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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(11 intermediate revisions by the same user not shown)
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 Source Code==
−
Square analogue panel meter.
 
−
A simulation only component - the needle value is set solely by the 'SetValue' macro.
 
  
−
==Examples==
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_IndicatorMeter.fcfx FC_Comp_Source_IndicatorMeter.fcfx]
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_IndicatorMeter.fcfx FC_Comp_Source_IndicatorMeter.fcfx]
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
 
−
Set the meter needle to a new position based on the current scaling properties.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|FLOAT]] ''Value''
 
−
::Needle position between min and max
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
  
  
−
==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''.
 
  
−
Minimum value to show on the meter.
 
  
−
<span style="font-weight: normal;"><u>Maximum</u></span>
+
''No detailed description exists yet for this component''
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''val_max''.
+
==Examples==
  
−
Maximum value to show on the meter.
 
  
−
<span style="font-weight: normal;"><u>BG Color</u></span>
 
  
−
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''bg_color''.
 
  
−
Color of the meter scale background.
 
  
−
<span style="font-weight: normal;"><u>Positive Color</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ink_color''.
 
  
−
Color of the scale gradations for positive values.
 
  
−
<span style="font-weight: normal;"><u>Negative Color</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''neg_color''.
 
  
−
Color of the scale gradations for negative values.
 
  
−
<span style="font-weight: normal;"><u>Pointer Color</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''NeedleColor''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
<span style="font-weight: normal;"><u>Label Color</u></span>
+
''<span style="color:red;">No additional examples</span>''
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''label_color''.
 
  
−
Color of the meter's title label.
 
  
−
<span style="font-weight: normal;"><u>Divisions</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_count''.
 
  
−
Number of large scale divisions..
 
  
−
<span style="font-weight: normal;"><u>Subdivisions</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_subdiv''.
 
  
−
Number of sub-divisions in between each major division.
 
  
−
<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_marks''.
 
  
−
Show or hide the scale markings.
 
  
−
<span style="font-weight: normal;"><u>Decimals</u></span>
+
==Macro reference==
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''dec_places''.
+
===SetValue===
 +
{| 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;" | '''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''
 +
|}
  
−
Number of decimal points to show on scale values.
 
  
−
<span style="font-weight: normal;"><u>Text Size %</u></span>
+
==Property reference==
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''num_size''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Text height of the scale values.
+
| 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>Font</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Font picker'' and can be referenced with the variable name ''num_font''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Range
−
Font for the scale value numbers.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Show</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Minimum
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_numbers''.
+
|-
−
 
+
| colspan="2" | Minimum value to show on the meter.&nbsp;
−
Show or hide the scale number values.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
<span style="font-weight: normal;"><u>Text</u></span>
+
| width="90%" | Maximum
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label_text''.
+
| colspan="2" | Maximum value to show on the meter.&nbsp;
−
 
+
|-
−
A title label to make the meter easier to identify.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
−
<span style="font-weight: normal;"><u>Text Size %</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''label_size''.
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
 
+
| width="90%" | BG Color
−
Height of the label text.
+
|-
−
 
+
| colspan="2" | Color of the meter scale background.&nbsp;
−
<span style="font-weight: normal;"><u>Font</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
This property is of type ''Font picker'' and can be referenced with the variable name ''label_font''.
+
| width="90%" | Positive Color
−
 
+
|-
−
Font for printing the label.
+
| colspan="2" | Color of the scale gradations for positive values.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Show</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Negative Color
−
This property is of type ''True or false'' and can be referenced with the variable name ''show_label''.
+
|-
−
 
+
| colspan="2" | Color of the scale gradations for negative values.&nbsp;
−
Show or hide the title label.
+
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Pointer Color
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Label Color
 +
|-
 +
| colspan="2" | Color of the meter's title label.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Marks
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Divisions
 +
|-
 +
| colspan="2" | Number of large scale divisions..&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Subdivisions
 +
|-
 +
| colspan="2" | Number of sub-divisions in between each major division.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Show
 +
|-
 +
| colspan="2" | Show or hide the scale markings.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Numbers
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Decimals
 +
|-
 +
| colspan="2" | Number of decimal points to show on scale values.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Text Size %
 +
|-
 +
| colspan="2" | Text height of the scale values.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
 +
| width="90%" | Font
 +
|-
 +
| colspan="2" | Font for the scale value numbers.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Show
 +
|-
 +
| colspan="2" | Show or hide the scale number values.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Text
 +
|-
 +
| colspan="2" | A title label to make the meter easier to identify.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Text Size %
 +
|-
 +
| colspan="2" | Height of the label text.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
 +
| width="90%" | Font
 +
|-
 +
| colspan="2" | Font for printing the label.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Show
 +
|-
 +
| colspan="2" | Show or hide the title label.&nbsp;
 +
|}

Latest revision as of 13:11, 7 February 2023

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 Source Code

Please click here to download the component source project: FC_Comp_Source_IndicatorMeter.fcfx

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

SetValue

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-conn-icon.png Range
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-conn-icon.png Style
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-conn-icon.png Marks
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-conn-icon.png Numbers
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-conn-icon.png Label
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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Indicator_Meter_(Indicators)&oldid=38084"