Difference between revisions of "Component: Indicator Gauge (Indicators)"
From Flowcode Help
Jump to navigationJump to search| (10 intermediate revisions by the same user not shown) | |||
| Line 15: | Line 15: | ||
Simulation only round gauge/dial for SCADA applications. The range of values displayed is easily adjusted. | Simulation only round gauge/dial for SCADA applications. The range of values displayed is easily adjusted. | ||
| − | ==Component | + | ==Component Source Code== |
| − | + | 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] | |
| + | |||
| + | 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== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 29: | Line 59: | ||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
| + | |||
| + | ===GetValue=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 44: | Line 85: | ||
| + | ===SetRange=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | 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="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| − | | width="90%" | | + | | width="90%" | Maximum |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Maximum value for the scale |
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===SetValue=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue''' |
|- | |- | ||
| − | | colspan="2" | Set the | + | | 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="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| − | | width="90%" | | + | | width="90%" | Value |
|- | |- | ||
| − | | colspan="2" | | + | | 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
| Line 93: | Line 134: | ||
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | | 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 | ||
|- | |- | ||
|- | |- | ||
| Line 114: | Line 159: | ||
|- | |- | ||
| colspan="2" | The default value used on initialise or runtime start. | | 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="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| Line 139: | Line 188: | ||
|- | |- | ||
| colspan="2" | Distance above component center to draw the title | | 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="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| Line 169: | Line 222: | ||
|- | |- | ||
| colspan="2" | Distance above component center to draw the label | | 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="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| Line 194: | Line 251: | ||
|- | |- | ||
| colspan="2" | Number of smaller scale divisions in between the numbered ones. | | 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="10%" align="center" | [[File:Fc9-type-2-icon.png]] | ||
| Line 214: | Line 275: | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Latest revision as of 13:11, 7 February 2023
| Author | Matrix Ltd |
| Version | 1.3 |
| Category | Indicators |
Contents
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 |
