Jump to content

Component: Indicator Gauge (Indicators): Difference between revisions

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
No edit summary
No edit summary
Line 16: Line 16:


==Component Source Code==
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_IndicatorGauge.fcfx FC_Comp_Source_IndicatorGauge.fcfx]


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]
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]


==Detailed description==
==Detailed description==




Line 32: Line 36:


==Examples==
==Examples==




Line 46: Line 52:


==Macro reference==
==Macro reference==
{| 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. 
|-
|-
| 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''
|}
{| 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. 
|-
|-
| 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. 
|-
| 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''
|}
{| 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;" | '''SetRange'''
|-
| colspan="2" | Set the minimum and maximum values of the scale 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Minimum
|-
| colspan="2" | Minimum value for the scale 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Maximum
|-
| colspan="2" | Maximum value for the scale 
|-
| 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''
|}
==Property reference==
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Range
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Minimum
|-
| colspan="2" | Minimum value that the meter will show (fully counter-clockwise) 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Maximum
|-
| colspan="2" | Maximum value that the meter will  show (fully clockwsie) 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Startup State
|-
| colspan="2" | Sets the initial value when loading the project or when the runtime starts. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Default Value
|-
| colspan="2" | The default value used on initialise or runtime start. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Title
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Title
|-
| colspan="2" | Decides if the component title is shown 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Title Colour
|-
| colspan="2" | Title Label Color 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title Text
|-
| colspan="2" | Title Label Text 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Title Scale
|-
| colspan="2" | Controls the size of the title text on the panel, default 1.2 
|-
| 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" 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-7-icon.png]]
| width="90%" | Show Label
|-
| colspan="2" | Decides if a label is shown detailing current setting of the control knob. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Label Colour
|-
| colspan="2" | Sets the label colour 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Label Units
|-
| colspan="2" | Adds a unit to the end of the label 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Label Decimal Points
|-
| colspan="2" | Number of decinal points to draw on the label 
|-
| 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 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Label Offset
|-
| colspan="2" | Distance above component center to draw the label 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | 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. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Text Size %
|-
| colspan="2" | Height of the number label text. 
|-
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Font for the number labels. 
|-
| 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. 
|-
| 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. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scheme
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | BG Color
|-
| colspan="2" | Colour for the meter background. 
|-
| 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. 
|-
| 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. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Needle Color
|-
| colspan="2" |  
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:22, 20 January 2023

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

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

==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
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=33409"