Component: Component Label (Misc) - Revision history

Wiki bot at 13:13, 7 February 2023

2023-02-07T13:13:43Z

Wiki bot at 12:22, 3 February 2023

2023-02-03T12:22:44Z

Wiki bot at 12:03, 3 February 2023

2023-02-03T12:03:58Z

Show changes

Wiki bot at 11:53, 3 February 2023

2023-02-03T11:53:13Z

Wiki bot at 16:51, 30 January 2023

2023-01-30T16:51:03Z

Show changes

Wiki bot at 10:01, 27 January 2023

2023-01-27T10:01:00Z

Show changes

Wiki bot at 15:25, 20 January 2023

2023-01-20T15:25:34Z

Show changes

Wiki bot at 15:17, 20 January 2023

2023-01-20T15:17:58Z

Show changes

Wiki bot at 14:14, 20 January 2023

2023-01-20T14:14:12Z

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd. |- | width="20%" style="color:gray;" | Version | 1.2 |- | width="20%" style="color:gra..."

2023-01-16T14:43:47Z

Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd. |- | width="20%" style="color:gray;" | Version | 1.2 |- | width="20%" style="color:gra..."

New page

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color:gray;" | Version
| 1.2
|-
| width="20%" style="color:gray;" | Category
| Misc
|}

==Component Label component==
Add a label to a component by including this component as a sub-component. The label will always face the viewer and move with its parent object. Text for the label is automatically read from the host component's name or any chosen property.

==Component Source Code==

Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_component_label.fcfx FC_Comp_Source_component_label.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''<span style="color:red;">No additional examples</span>''

==Downloadable 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;" | '''SetTargets'''
|-
| colspan="2" | Set the objects used to determine the label text and position. 
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | TextObject
|-
| colspan="2" | Object that will provide the label text from its name or a property. 
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | BoundsObject
|-
| colspan="2" | Object that will set the label position and bounding box. 
|-
| 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;" | '''ShowProperty'''
|-
| colspan="2" | Sets the label to show a named property of the target object. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Property
|-
| colspan="2" | Name of the property to show. 
|-
| 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;" | '''SetPosition'''
|-
| colspan="2" | Set where the label will appear relative to the object. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
|-
| colspan="2" | Set the position - choose a preset from the list of constants, or 'Position XYZ to enter values below. 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | X
|-
| colspan="2" | X axis offset (only if 'Position_XYZ' selected for 'Position') 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Y
|-
| colspan="2" | Y axis offset (only if 'Position_XYZ' selected for 'Position') 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Z
|-
| colspan="2" | Z axis offset (only if 'Position_XYZ' selected for 'Position') 
|-
| 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;" | '''Hide'''
|-
| colspan="2" | Hides the label. 
|-
|-
| 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;" | '''SetColor'''
|-
| colspan="2" | Sets the color of the label using a single ULONG value - such as returned by panel GetColor functions. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Color
|-
| colspan="2" | Color to set the labels to. 
|-
| 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;" | '''SetColorRGB'''
|-
| colspan="2" | Set the label color using separate red, green and blue color channels. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Red
|-
| colspan="2" | Color parameter 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Green
|-
| colspan="2" | Color parameter 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Blue
|-
| colspan="2" | Color parameter 
|-
| 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;" | '''Update'''
|-
| colspan="2" | Refresh the label after a change. 
|-
|-
| 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;" | '''ShowName'''
|-
| colspan="2" | Sets the label to show the target object's name 
|-
|-
| 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%" | Show
|-
| colspan="2" | Decide what label to show... None - no labels are displayed Name - shows the component's name Property - shows a property value of the component (a field for the property name will appear below) 
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Label target
|-
| colspan="2" | Set the object from which the label text will be taken. If none is given, defaults to the parent of the label component. 
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Bounds target
|-
| colspan="2" | Set the object used to set the dimensions used for the positioning of the labels. If none is given, defaults to the parent of the label component. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto Update
|-
| colspan="2" | Automatically update the label whenever the target's name or labelled property changes. Use this sparingly, as it requires the component to regularly poll the component for changes!! 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Color
|-
| colspan="2" | Color of the label text. 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Color for label backgroiunds - may be transparent. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Always On Top
|-
| colspan="2" | Whether labels should always be draw on top of other objects. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Size
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Scale
|-
| colspan="2" | Sets the basic size (text height) of the labels. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Follow Zoom
|-
| colspan="2" | Whether labels get bigger and smaller when the panel is zoomed in and out. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Offset
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Auto
|-
| colspan="2" | Attempt to automatically move the label to the side of the object. Choose a positive or negative offset in any of the three axes. When 'off', the manual offsett values can be edited below. 
|}

@@ 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_temp/component_label.fcfx FC_Comp_Source_temp/component_label.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_component_label.fcfx FC_Comp_Source_component_label.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/component_label.fcfx FC_Comp_Source_temp/component_label.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_component_label.fcfx FC_Comp_Source_component_label.fcfx]
 ==Detailed description==
@@ Line 48: / Line 48: @@
 ''<span style="color:red;">No additional examples</span>''

@@ Line 48: / Line 48: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 53: / Line 55: @@
 ==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 76: / Line 79: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 94: / Line 98: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 127: / Line 132: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 140: / Line 146: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 158: / Line 165: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 186: / Line 194: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 199: / Line 208: @@
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-