Difference between revisions of "Component: Logo Indicator (Indicators)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Indicators
 
| Indicators
 
|}
 
|}
 +
 +
 +
==Logo Indicator component==
 +
A simple component to display multiple icons relating to the state of a machine or process. Includes icons such as: tick, cross, alert, stop, go and coloured lights.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_IndicatorLogo.fcfx FC_Comp_Source_IndicatorLogo.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_IndicatorLogo.fcfx FC_Comp_Source_IndicatorLogo.fcfx]
 +
 +
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
  
==[[File:Component Icon 9f9ffa92_a20d_4ba8_94e1_04e45bdea154.png|Image]] Logo Indicator component==
+
 
A simple component to display multiple icons relating to the state of a machine or process.
+
 
Includes icons such as: tick, cross, alert, stop, go and coloured lights.
+
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
''<span style="color:red;">No additional examples</span>''
 
  
  
==Downloadable macro reference==
 
  
''This component does not contain any downloadable macros''
 
  
==Simulation macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>AssignLogo</tt></u></span>===
 
Sets the logo displayed on the indicator.
 
  
'''Parameters'''
 
  
:[[Variable Types|BYTE]] ''LogoIdx''
 
::Logo Index: 1=Tick, 2=Cross, 3=Exclamation, 4=Green, 5=Amber, 6=Red, 7=Stop, 8=Go
 
  
  
'''Return value'''
 
  
:''This call does not return a value''
 
  
  
  
  
==Property reference==
 
<span style="font-weight: normal;"><u>Default Icon</u></span>
 
  
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DefaultIcon''.
 
  
Icon that is automatically loaded when starting the runtime or reopening the project.
 
  
The Don't Modify setting will leave the icon in it's last written state.
 
  
<span style="font-weight: normal;"><u>Show Title</u></span>
 
  
This property is of type ''True or false'' and can be referenced with the variable name ''ShowTitle''.
 
  
Decides if the component title is shown
 
  
<span style="font-weight: normal;"><u>Title Colour</u></span>
 
  
This property is of type ''Color picker'' and can be referenced with the variable name ''TitleColour''.
 
  
Title Label Color
 
  
<span style="font-weight: normal;"><u>Title Text</u></span>
+
''<span style="color:red;">No additional examples</span>''
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
  
This property is of type ''Line of text'' and can be referenced with the variable name ''TitleText''.
 
  
Title Label Text
 
  
<span style="font-weight: normal;"><u>Title Scale</u></span>
 
  
This property is of type ''Floating point'' and can be referenced with the variable name ''TitleScale''.
+
==Macro reference==
  
Controls the size of the title text on the panel, default 1.2
+
===AssignLogo===
 +
{| 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;" | '''AssignLogo'''
 +
|-
 +
| colspan="2" | Sets the logo displayed on the indicator.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | LogoIdx
 +
|-
 +
| colspan="2" | Logo Index: 1=Tick, 2=Cross, 3=Exclamation, 4=Green, 5=Amber, 6=Red, 7=Stop, 8=Go&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''
 +
|}
 +
 
 +
 
 +
==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%" | Default Icon
 +
|-
 +
| colspan="2" | Icon that is automatically loaded when starting the runtime or reopening the project. The Don't Modify setting will leave the icon in it's last written state.&nbsp;
 +
|-
 +
| 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="90%" | Show Title
 +
|-
 +
| colspan="2" | Decides if the component title is shown&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Title Colour
 +
|-
 +
| colspan="2" | Title Label Color&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Title Text
 +
|-
 +
| colspan="2" | Title Label Text&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Title Scale
 +
|-
 +
| colspan="2" | Controls the size of the title text on the panel, default 1.2&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Title Offset
 +
|-
 +
| colspan="2" | Distance above component center to draw the title&nbsp;
 +
|}

Latest revision as of 13:11, 7 February 2023

Author Matrix TSL
Version 1.0
Category Indicators


Logo Indicator component

A simple component to display multiple icons relating to the state of a machine or process. Includes icons such as: tick, cross, alert, stop, go and coloured lights.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_IndicatorLogo.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_IndicatorLogo.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

Fc9-comp-macro.png AssignLogo
Sets the logo displayed on the indicator. 
Fc9-u8-icon.png - BYTE LogoIdx
Logo Index: 1=Tick, 2=Cross, 3=Exclamation, 4=Green, 5=Amber, 6=Red, 7=Stop, 8=Go 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Default Icon
Icon that is automatically loaded when starting the runtime or reopening the project. The Don't Modify setting will leave the icon in it's last written state. 
Fc9-conn-icon.png Title
Fc9-type-7-icon.png Show Title
Decides if the component title is shown 
Fc9-type-1-icon.png Title Colour
Title Label Color 
Fc9-type-10-icon.png Title Text
Title Label Text 
Fc9-type-15-icon.png Title Scale
Controls the size of the title text on the panel, default 1.2 
Fc9-type-15-icon.png Title Offset
Distance above component center to draw the title