Component: Indicator Gauge (Indicators): Difference between revisions

Revision as of 12:01, 3 February 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_temp/IndicatorGauge.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/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

@@ Line 17: / Line 17: @@
 ==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 download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/IndicatorGauge.fcfx FC_Comp_Source_temp/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_temp/IndicatorGauge.fcfx FC_Comp_Source_temp/IndicatorGauge.fcfx]
 ==Detailed description==
@@ Line 57: / Line 57: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 79: / Line 81: @@
-===SetValue===
+===SetRange===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRange'''
+|-
+| colspan="2" | Set the minimum and maximum values of the scale&nbsp;
+|-
 |-
-| 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%" | Minimum
 |-
+| colspan="2" | Minimum value for the scale&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | Value
+| width="90%" | Maximum
 |-
-| colspan="2" | The value on the scale to move the pointer to.&nbsp;
+| colspan="2" | Maximum value for the scale&nbsp;
 |-
-| 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-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===SetRange===
+===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;" | '''SetRange'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
 |-
-| colspan="2" | Set the minimum and maximum values of the scale&nbsp;
+| 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%" | Minimum
+| width="90%" | Value
 |-
-| colspan="2" | Minimum value for the scale&nbsp;
+| colspan="2" | The value on the scale to move the pointer to.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[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''
 |}

Wiki bot (talk | contribs)