Jump to content

Component: Component Label (Misc): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,422 edits
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..."
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(14 intermediate revisions by 2 users not shown)
Line 17: Line 17:
==Component Source Code==
==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]
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_component_label.fcfx FC_Comp_Source_component_label.fcfx]


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


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


==Examples==
==Examples==


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


==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===Hide===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Hide'''
|-
| colspan="2" | Hides the label.&nbsp;
|-
|-
| 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.&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''
|}
 
 
===SetColor===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetColor'''
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| colspan="2" | Sets the color of the label using a single ULONG value - such as returned by panel GetColor functions.&nbsp;
| width="90%" | TextObject
|-
|-
| colspan="2" | Object that will provide the label text from its name or a property.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | BoundsObject
| width="90%" | Color
|-
|-
| colspan="2" | Object that will set the label position and bounding box.&nbsp;
| colspan="2" | Color to set the labels to.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 52: Line 94:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetColorRGB===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetColorRGB'''
|-
| colspan="2" | Set the label color using separate red, green and blue color channels.&nbsp;
|-
|-
| 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.&nbsp;
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Red
|-
| colspan="2" | Color parameter&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Green
|-
|-
| colspan="2" | Color parameter&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Property
| width="90%" | Blue
|-
|-
| colspan="2" | Name of the property to show.&nbsp;
| colspan="2" | Color parameter&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 70: Line 123:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetPosition===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPosition'''
| width="90%" class="mtx-class-macrohead" | '''SetPosition'''
|-
|-
| colspan="2" | Set where the label will appear relative to the object.&nbsp;
| colspan="2" | Set where the label will appear relative to the object.&nbsp;
Line 103: Line 157:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetTargets===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Hide'''
| width="90%" class="mtx-class-macrohead" | '''SetTargets'''
|-
|-
| colspan="2" | Hides the label.&nbsp;
| colspan="2" | Set the objects used to determine the label text and position.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | TextObject
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| colspan="2" | Object that will provide the label text from its name or a property.&nbsp;
| 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.&nbsp;
| 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.&nbsp;
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Color
|-
| colspan="2" | Color to set the labels to.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 134: Line 181:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ShowName===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetColorRGB'''
| width="90%" class="mtx-class-macrohead" | '''ShowName'''
|-
|-
| colspan="2" | Set the label color using separate red, green and blue color channels.&nbsp;
| colspan="2" | Sets the label to show the target object's name&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Red
|-
| colspan="2" | Color parameter&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Green
|-
| colspan="2" | Color parameter&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Blue
|-
|-
| colspan="2" | Color parameter&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 162: Line 195:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ShowProperty===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Update'''
| width="90%" class="mtx-class-macrohead" | '''ShowProperty'''
|-
|-
| colspan="2" | Refresh the label after a change.&nbsp;
| colspan="2" | Sets the label to show a named property of the target object.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Property
|-
|-
| colspan="2" | Name of the property to show.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 175: Line 214:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Update===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShowName'''
| width="90%" class="mtx-class-macrohead" | '''Update'''
|-
|-
| colspan="2" | Sets the label to show the target object's name&nbsp;
| colspan="2" | Refresh the label after a change.&nbsp;
|-
|-
|-
|-
Line 186: Line 226:
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
Line 218: Line 256:
| 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!!&nbsp;
| 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!!&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
| width="90%" class="mtx-class-propfolder" | Appearance
|-
|-
|-
|-
Line 237: Line 275:
| colspan="2" | Whether labels should always be draw on top of other objects.&nbsp;
| colspan="2" | Whether labels should always be draw on top of other objects.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Size
| width="90%" class="mtx-class-propfolder" | Size
|-
|-
|-
|-
Line 251: Line 289:
| colspan="2" | Whether labels get bigger and smaller when the panel is zoomed in and out.&nbsp;
| colspan="2" | Whether labels get bigger and smaller when the panel is zoomed in and out.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Offset
| width="90%" class="mtx-class-propfolder" | Offset
|-
|-
|-
|-

Latest revision as of 14:36, 13 July 2026

Author Matrix Ltd.
Version 1.2
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 to download the component source project: FC_Comp_Source_component_label.fcfx

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

Hide

Hide
Hides the label. 
- VOID Return


SetColor

SetColor
Sets the color of the label using a single ULONG value - such as returned by panel GetColor functions. 
- ULONG Color
Color to set the labels to. 
- VOID Return


SetColorRGB

SetColorRGB
Set the label color using separate red, green and blue color channels. 
- BYTE Red
Color parameter 
- BYTE Green
Color parameter 
- BYTE Blue
Color parameter 
- VOID Return


SetPosition

SetPosition
Set where the label will appear relative to the object. 
- BYTE Position
Set the position - choose a preset from the list of constants, or 'Position XYZ to enter values below. 
- FLOAT X
X axis offset (only if 'Position_XYZ' selected for 'Position') 
- FLOAT Y
Y axis offset (only if 'Position_XYZ' selected for 'Position') 
- FLOAT Z
Z axis offset (only if 'Position_XYZ' selected for 'Position') 
- VOID Return


SetTargets

SetTargets
Set the objects used to determine the label text and position. 
- HANDLE TextObject
Object that will provide the label text from its name or a property. 
- HANDLE BoundsObject
Object that will set the label position and bounding box. 
- VOID Return


ShowName

ShowName
Sets the label to show the target object's name 
- VOID Return


ShowProperty

ShowProperty
Sets the label to show a named property of the target object. 
- STRING Property
Name of the property to show. 
- VOID Return


Update

Update
Refresh the label after a change. 
- VOID Return


Property reference

Properties
Show
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) 
Label target
Set the object from which the label text will be taken. If none is given, defaults to the parent of the label component. 
Bounds target
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. 
Auto Update
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!! 
Appearance
Color
Color of the label text. 
Background
Color for label backgroiunds - may be transparent. 
Always On Top
Whether labels should always be draw on top of other objects. 
Size
Scale
Sets the basic size (text height) of the labels. 
Follow Zoom
Whether labels get bigger and smaller when the panel is zoomed in and out. 
Offset
Auto
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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Component_Label_(Misc)&oldid=47909"