Component: Indicator Gauge (Indicators)
From Flowcode Help
Jump to navigationJump to search| 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 |
| 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 |
==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 |
