Component: Control Knob (Controls)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix Ltd |
| Version | 1.3 |
| Category | Controls |
Contents
Control Knob component
Rotary control designed for SCADA. Has customisable value markings around the control. Simulation only.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_ControlKnob.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_ControlKnob.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 |
Property reference
|
Properties |
|
Range |
|
Minimum |
| The minimum value that the knob will output (fully counter_clockwise) | |
|
|
Maximum |
| The maximum value that the knob will output (fully clockwise) | |
|
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 |
| How many decimal places to show on the number labels. | |
|
|
Text Size % |
| Height of the number label text. | |
|
Font |
| Font for the number labels. | |
|
|
Divisions |
| Number of labelled positions around the knob. | |
|
|
Subdivisions |
| Number of divisions between the numbered ones. | |
|
|
Scheme |
|
BG Color |
| Background colour behind the knob labelling - may be transparent. | |
|
|
Positive Color |
| Colour for number labels which are less than zero. | |
|
|
Negative Color |
| Colour for number labels which are greater than zero. | |
|
|
Pointer Colour |
|
|
Buttons |
|
|
Show Buttons |
| Controls if the adjustment buttons are shown on the scale arc or not. | |
|
|
Button Color |
| Color for the component label text. | |
|
|
Adjustment Value |
| Sets the button adjustment value, will round the value to the nearest whole adjustment. For example with an adjustment of 1,0 the adjustment buttons will jump to the next whole number. | |
==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 |
Property reference
|
|
Properties |
|
|
Range |
|
|
Minimum |
| The minimum value that the knob will output (fully counter_clockwise) | |
|
|
Maximum |
| The maximum value that the knob will output (fully clockwise) | |
|
|
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 |
| How many decimal places to show on the number labels. | |
|
|
Text Size % |
| Height of the number label text. | |
|
|
Font |
| Font for the number labels. | |
|
|
Divisions |
| Number of labelled positions around the knob. | |
|
|
Subdivisions |
| Number of divisions between the numbered ones. | |
|
|
Scheme |
|
|
BG Color |
| Background colour behind the knob labelling - may be transparent. | |
|
|
Positive Color |
| Colour for number labels which are less than zero. | |
|
|
Negative Color |
| Colour for number labels which are greater than zero. | |
|
|
Pointer Colour |
|
|
Buttons |
|
|
Show Buttons |
| Controls if the adjustment buttons are shown on the scale arc or not. | |
|
|
Button Color |
| Color for the component label text. | |
|
|
Adjustment Value |
| Sets the button adjustment value, will round the value to the nearest whole adjustment. For example with an adjustment of 1,0 the adjustment buttons will jump to the next whole number. | |
==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 |
Property reference
|
|
Properties |
|
|
Range |
|
|
Minimum |
| The minimum value that the knob will output (fully counter_clockwise) | |
|
|
Maximum |
| The maximum value that the knob will output (fully clockwise) | |
|
|
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 |
| How many decimal places to show on the number labels. | |
|
|
Text Size % |
| Height of the number label text. | |
|
|
Font |
| Font for the number labels. | |
|
|
Divisions |
| Number of labelled positions around the knob. | |
|
|
Subdivisions |
| Number of divisions between the numbered ones. | |
|
|
Scheme |
|
|
BG Color |
| Background colour behind the knob labelling - may be transparent. | |
|
|
Positive Color |
| Colour for number labels which are less than zero. | |
|
|
Negative Color |
| Colour for number labels which are greater than zero. | |
|
|
Pointer Colour |
|
|
Buttons |
|
|
Show Buttons |
| Controls if the adjustment buttons are shown on the scale arc or not. | |
|
|
Button Color |
| Color for the component label text. | |
|
|
Adjustment Value |
| Sets the button adjustment value, will round the value to the nearest whole adjustment. For example with an adjustment of 1,0 the adjustment buttons will jump to the next whole number. | |
