Jump to content

Component: Indicator Gauge (Indicators): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,426 edits
XML import
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(17 intermediate revisions by 2 users not shown)
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 Source Code==
Simulation only round gauge/dial for SCADA applications. 
The range of values displayed is easily adjusted.


==Examples==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_IndicatorGauge.fcfx FC_Comp_Source_IndicatorGauge.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_IndicatorGauge.fcfx FC_Comp_Source_IndicatorGauge.fcfx]


==Downloadable macro reference==
==Detailed description==


''This component does not contain any downloadable macros''


==Simulation macro reference==


===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></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'''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|FLOAT]]




===<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.


'''Parameters'''


:[[Variable Types|FLOAT]] ''Value''
::The value on the scale to move the pointer to.




'''Return value'''
''No detailed description exists yet for this component''


:[[Variable Types|FLOAT]]
==Examples==




===<span style="font-weight: normal;"><u><tt>SetRange</tt></u></span>===
Set the minimum and maximum values of the scale


'''Parameters'''


:[[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''








==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 that the meter will show (fully counter-clockwise)


<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''.
''<span style="color:red;">No additional examples</span>''


Maximum value that the meter will  show (fully clockwsie)


<span style="font-weight: normal;"><u>Startup State</u></span>


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''StartupState''.


Sets the initial value when loading the project or when the runtime starts.


<span style="font-weight: normal;"><u>Default Value</u></span>


This property is of type ''Floating point'' and can be referenced with the variable name ''DefaultValue''.


The default value used on initialise or runtime start.


<span style="font-weight: normal;"><u>Show Title</u></span>


This property is of type ''True or false'' and can be referenced with the variable name ''ShowTitle''.


Decides if the component title is shown


<span style="font-weight: normal;"><u>Title Colour</u></span>


This property is of type ''Color picker'' and can be referenced with the variable name ''TitleColour''.
==Macro reference==


Title Label Color
===GetValue===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


<span style="font-weight: normal;"><u>Title Text</u></span>


This property is of type ''Line of text'' and can be referenced with the variable name ''TitleText''.
===SetRange===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetRange'''
|-
| colspan="2" | Set the minimum and maximum values of the scale&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Minimum
|-
| colspan="2" | Minimum value for the scale&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Maximum
|-
| colspan="2" | Maximum value for the scale&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''
|}


Title Label Text


<span style="font-weight: normal;"><u>Title Scale</u></span>
===SetValue===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


This property is of type ''Floating point'' and can be referenced with the variable name ''TitleScale''.


Controls the size of the title text on the panel, default 1.2
==Property reference==


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

Latest revision as of 14:37, 13 July 2026

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

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

GetValue

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


SetRange

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


SetValue

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


Property reference

Properties
Range
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. 
Title
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 
Label
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 
Numeric Labels
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. 
Scheme
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
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Indicator_Gauge_(Indicators)&oldid=48160"