Jump to content

Component: RadioButton (Digital Control ): Difference between revisions

From Flowcode Help
No edit summary
No edit summary
Line 22: Line 22:


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




Line 46: Line 48:


==Examples==
==Examples==




Line 67: Line 71:
{{Fcfile|Logging_Example.fcsx|Logging Example}}
{{Fcfile|Logging_Example.fcsx|Logging Example}}


==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;" | '''GetIndex'''
|-
| colspan="2" | Gets the current selected index. Returns 1 - NumberOptions 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


 
==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;" | '''Prv_DisplaySelectedItem'''
|-
| colspan="2" |  
|-
|-
| 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''
|}
 
 
{| 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;" | '''SetIndex'''
|-
| colspan="2" | Sets the selected item. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | Range: 1 - Number Options 
|-
| 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" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Number Options
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Initial Value
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Text1
|-
| colspan="2" | Text to display 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Text2
|-
| colspan="2" | Text to display 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Text3
|-
| colspan="2" | Text to display 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Colour
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Text Colour
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Text Scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Spacing
|-
| colspan="2" | Space between radio button items 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Text Spacing
|-
| colspan="2" | Space between text and radio button item. 
|}==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;" | '''GetIndex'''
|-
| colspan="2" | Gets the current selected index. Returns 1 - NumberOptions 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| 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;" | '''Prv_DisplaySelectedItem'''
|-
| colspan="2" |  
|-
|-
| 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''
|}
 
 
{| 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;" | '''SetIndex'''
|-
| colspan="2" | Sets the selected item. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | Range: 1 - Number Options 
|-
| 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" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Number Options
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Initial Value
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Text1
|-
| colspan="2" | Text to display 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Text2
|-
| colspan="2" | Text to display 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Text3
|-
| colspan="2" | Text to display 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Colour
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Text Colour
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Text Scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Spacing
|-
| colspan="2" | Space between radio button items 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Text Spacing
|-
| colspan="2" | Space between text and radio button item. 
|}==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;" | '''GetIndex'''
|-
| colspan="2" | Gets the current selected index. Returns 1 - NumberOptions 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| 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;" | '''Prv_DisplaySelectedItem'''
|-
| colspan="2" |  
|-
|-
| 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''
|}
 
 
{| 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;" | '''SetIndex'''
|-
| colspan="2" | Sets the selected item. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | Range: 1 - Number Options 
|-
| 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" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Number Options
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Initial Value
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Text1
|-
| colspan="2" | Text to display 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Text2
|-
| colspan="2" | Text to display 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Text3
|-
| colspan="2" | Text to display 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Colour
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Label
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Text Colour
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Text Scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Spacing
|-
| colspan="2" | Space between radio button items 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Text Spacing
|-
| colspan="2" | Space between text and radio button item. 
|}==Macro reference==


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

Revision as of 16:50, 30 January 2023

Author Matrix TSL
Version 1.0
Category Digital Control


RadioButton component

A simple radio button component allowing an array of up to 20 on/off type settings.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_RadioButton.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_RadioButton.fcsx

Detailed description

No detailed description exists yet for this component

Examples

A basic example using two circular knobs to simulate data e.g., temperature. Both xy chart and Console, log the data. A radio button is used to start, stop and reset logging.

Logging Example


Macro reference

GetIndex
Gets the current selected index. Returns 1 - NumberOptions 
- BYTE Return


Prv_DisplaySelectedItem
 
- VOID Return


SetIndex
Sets the selected item. 
- BYTE Index
Range: 1 - Number Options 
- VOID Return



Property reference

Properties
Number Options
 
Initial Value
 
Text1
Text to display 
Text2
Text to display 
Text3
Text to display 
Style
 
Colour
 
Show Label
 
Text Colour
 
Text Scale
 
Spacing
Space between radio button items 
Text Spacing
Space between text and radio button item.