Jump to content

Component: Indicator Gauge (Indicators): Difference between revisions

From Flowcode Help
Newer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
XML import
 
No edit summary
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix Ltd
| Matrix Ltd
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 1.3 (Release)
| 1.3
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| Indicators
| Indicators
|}
|}




==Indicator Gauge component==
Simulation only round gauge/dial for SCADA applications.  The range of values displayed is easily adjusted.


==[[File:Component Icon b0a73b26_a060_4bbc_a94e_d4ee2fd0edbd.png|Image]] Indicator Gauge component==
==Component Pack==
Simulation only round gauge/dial for SCADA applications. 
The range of values displayed is easily adjusted.


==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>GetValue</tt></u></span>===
''<span style="color:red;">No additional examples</span>''
Get the current scale value - this will be the most recent value set using "SetValue", or from the most recent mouse click if the component is in "Control"


mode.


'''Parameters'''
==Downloadable macro reference==


:''This macro has no parameters''
{| 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;" | '''GetValue'''
|-
| colspan="2" | Get the current scale value - this will be the most recent value set using "SetValue", or from the most recent mouse click if the component is in "Control" mode.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
{| 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 pointer to the given value on the scale.  Returns the angle required to point at the given value.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | The value on the scale to move the pointer to.&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|FLOAT]]


 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
|-
Set the pointer to the given value on the scale.  Returns the angle required to point at the given value.
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRange'''
'''Parameters'''
|-
 
| colspan="2" | Set the minimum and maximum values of the scale&nbsp;
:[[Variable Types|FLOAT]] ''Value''
|-
::The value on the scale to move the pointer to.
|-
 
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
| width="90%" | Minimum
'''Return value'''
|-
 
| colspan="2" | Minimum value for the scale&nbsp;
:[[Variable Types|FLOAT]]
|-
 
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
| width="90%" | Maximum
===<span style="font-weight: normal;"><u><tt>SetRange</tt></u></span>===
|-
Set the minimum and maximum values of the scale
| colspan="2" | Maximum value for the scale&nbsp;
 
|-
'''Parameters'''
| 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''
:[[Variable Types|FLOAT]] ''Minimum''
|}
::Minimum value for the scale
 
:[[Variable Types|FLOAT]] ''Maximum''
::Maximum value for the scale
 
 
'''Return value'''
 
:''This call does not return a value''




Line 78: Line 88:


==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 that the meter will show (fully counter-clockwise)
| 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 that the meter will  show (fully clockwsie)
|-
 
| colspan="2" | Minimum value that the meter will show (fully counter-clockwise)&nbsp;
<span style="font-weight: normal;"><u>Startup State</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''StartupState''.
| width="90%" | Maximum
 
|-
Sets the initial value when loading the project or when the runtime starts.
| colspan="2" | Maximum value that the meter will  show (fully clockwsie)&nbsp;
 
|-
<span style="font-weight: normal;"><u>Default Value</u></span>
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Startup State
This property is of type ''Floating point'' and can be referenced with the variable name ''DefaultValue''.
|-
 
| colspan="2" | Sets the initial value when loading the project or when the runtime starts.&nbsp;
The default value used on initialise or runtime start.
|-
 
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
<span style="font-weight: normal;"><u>Show Title</u></span>
| width="90%" | Default Value
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''ShowTitle''.
| colspan="2" | The default value used on initialise or runtime start.&nbsp;
 
|-
Decides if the component title is shown
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Show Title
<span style="font-weight: normal;"><u>Title Colour</u></span>
|-
 
| colspan="2" | Decides if the component title is shown&nbsp;
This property is of type ''Color picker'' and can be referenced with the variable name ''TitleColour''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
Title Label Color
| width="90%" | Title Colour
 
|-
<span style="font-weight: normal;"><u>Title Text</u></span>
| colspan="2" | Title Label Color&nbsp;
 
|-
This property is of type ''Line of text'' and can be referenced with the variable name ''TitleText''.
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
| width="90%" | Title Text
Title Label Text
|-
 
| colspan="2" | Title Label Text&nbsp;
<span style="font-weight: normal;"><u>Title Scale</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
This property is of type ''Floating point'' and can be referenced with the variable name ''TitleScale''.
| width="90%" | Title Scale
 
|-
Controls the size of the title text on the panel, default 1.2
| colspan="2" | Controls the size of the title text on the panel, default 1.2&nbsp;
 
|-
<span style="font-weight: normal;"><u>Show Label</u></span>
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
| width="90%" | Title Offset
This property is of type ''True or false'' and can be referenced with the variable name ''ShowLabel''.
|-
 
| colspan="2" | Distance above component center to draw the title&nbsp;
Decides if a label is shown detailing current setting of the control knob.
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
<span style="font-weight: normal;"><u>Label Colour</u></span>
| width="90%" | Show Label
 
|-
This property is of type ''Color picker'' and can be referenced with the variable name ''LabelColour''.
| colspan="2" | Decides if a label is shown detailing current setting of the control knob.&nbsp;
 
|-
Sets the label colour
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
| width="90%" | Label Colour
<span style="font-weight: normal;"><u>Label Units</u></span>
|-
 
| colspan="2" | Sets the label colour&nbsp;
This property is of type ''Line of text'' and can be referenced with the variable name ''LabelUnits''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
Adds a unit to the end of the label
| width="90%" | Label Units
 
|-
<span style="font-weight: normal;"><u>Label Decimal Points</u></span>
| colspan="2" | Adds a unit to the end of the label&nbsp;
 
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''LabelDecPoints''.
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
| width="90%" | Label Decimal Points
Number of decinal points to draw on the label
|-
 
| colspan="2" | Number of decinal points to draw on the label&nbsp;
<span style="font-weight: normal;"><u>Label Scale</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
This property is of type ''Floating point'' and can be referenced with the variable name ''LabelScale''.
| width="90%" | Label Scale
 
|-
Sets the size of the label on the panel, default 1.0
| colspan="2" | Sets the size of the label on the panel, default 1.0&nbsp;
 
|-
<span style="font-weight: normal;"><u>Decimals</u></span>
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
| width="90%" | Label Offset
This property is of type ''Signed integer'' and can be referenced with the variable name ''dec_places''.
|-
 
| colspan="2" | Distance above component center to draw the label&nbsp;
Number of decimal places to show on the number labels.
|-
 
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
<span style="font-weight: normal;"><u>Text Size %</u></span>
| width="90%" | Decimals
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''num_size''.
| colspan="2" | Number of decimal places to show on the number labels.&nbsp;
 
|-
Height of the number label text.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Text Size %
<span style="font-weight: normal;"><u>Font</u></span>
|-
 
| colspan="2" | Height of the number label text.&nbsp;
This property is of type ''Font picker'' and can be referenced with the variable name ''num_font''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
Font for the number labels.
| width="90%" | Font
 
|-
<span style="font-weight: normal;"><u>Divisions</u></span>
| colspan="2" | Font for the number labels.&nbsp;
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''marks_count''.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Divisions
Set the number of major scale divisions - these will be given number value labels.
|-
 
| colspan="2" | Set the number of major scale divisions - these will be given number value labels.&nbsp;
<span style="font-weight: normal;"><u>Subdivisions</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 ''marks_subdiv''.
| width="90%" | Subdivisions
 
|-
Number of smaller scale divisions in between the numbered ones.
| colspan="2" | Number of smaller scale divisions in between the numbered ones.&nbsp;
 
|-
<span style="font-weight: normal;"><u>BG Color</u></span>
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 
| width="90%" | BG Color
This property is of type ''Color picker with transparency'' and can be referenced with the variable name ''bg_color''.
|-
 
| colspan="2" | Colour for the meter background.&nbsp;
Colour for the meter background.
|-
 
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
<span style="font-weight: normal;"><u>Positive Color</u></span>
| width="90%" | Positive Color
 
|-
This property is of type ''Color picker'' and can be referenced with the variable name ''ink_color''.
| colspan="2" | Colour for the number labels for greater than zero.&nbsp;
 
|-
Colour for the number labels for greater than zero.
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
| width="90%" | Negative Color
<span style="font-weight: normal;"><u>Negative Color</u></span>
|-
 
| colspan="2" | Colour for the number labels for value greater than zero.&nbsp;
This property is of type ''Color picker'' and can be referenced with the variable name ''neg_color''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
Colour for the number labels for value greater than zero.
| width="90%" | Needle Color
 
|-
<span style="font-weight: normal;"><u>Needle Color</u></span>
| colspan="2" | &nbsp;
 
|-
This property is of type ''Color picker'' and can be referenced with the variable name ''NeedleColor''.
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
''<span style="color:red;">No additional information</span>''
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
|-
|}

Revision as of 16:22, 7 January 2022

Author Matrix Ltd
Version 1.3
Category Indicators


Indicator Gauge component

Simulation only round gauge/dial for SCADA applications. The range of values displayed is easily adjusted.

Component Pack

SCADA

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

GetValue
Get the current scale value - this will be the most recent value set using "SetValue", or from the most recent mouse click if the component is in "Control" mode. 
- FLOAT Return


SetValue
Set the pointer to the given value on the scale. Returns the angle required to point at the given value. 
- FLOAT Value
The value on the scale to move the pointer to. 
- FLOAT Return


SetRange
Set the minimum and maximum values of the scale 
- FLOAT Minimum
Minimum value for the scale 
- FLOAT Maximum
Maximum value for the scale 
- VOID Return



Property reference

Properties
Minimum
Minimum value that the meter will show (fully counter-clockwise) 
Maximum
Maximum value that the meter will show (fully clockwsie) 
Startup State
Sets the initial value when loading the project or when the runtime starts. 
Default Value
The default value used on initialise or runtime start. 
Show Title
Decides if the component title is shown 
Title Colour
Title Label Color 
Title Text
Title Label Text 
Title Scale
Controls the size of the title text on the panel, default 1.2 
Title Offset
Distance above component center to draw the title 
Show Label
Decides if a label is shown detailing current setting of the control knob. 
Label Colour
Sets the label colour 
Label Units
Adds a unit to the end of the label 
Label Decimal Points
Number of decinal points to draw on the label 
Label Scale
Sets the size of the label on the panel, default 1.0 
Label Offset
Distance above component center to draw the label 
Decimals
Number of decimal places to show on the number labels. 
Text Size %
Height of the number label text. 
Font
Font for the number labels. 
Divisions
Set the number of major scale divisions - these will be given number value labels. 
Subdivisions
Number of smaller scale divisions in between the numbered ones. 
BG Color
Colour for the meter background. 
Positive Color
Colour for the number labels for greater than zero. 
Negative Color
Colour for the number labels for value greater than zero. 
Needle Color
 
Connections
Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Indicator_Gauge_(Indicators)&oldid=27733"