Jump to content

Component: Component Labels (Misc): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,414 edits
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(12 intermediate revisions by 2 users not shown)
Line 16: Line 16:


==Component Source Code==
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_auto_labels.fcfx FC_Comp_Source_auto_labels.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_auto_labels.fcfx FC_Comp_Source_auto_labels.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_auto_labels.fcfx FC_Comp_Source_auto_labels.fcfx]


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




Line 40: Line 48:


==Examples==
==Examples==




Line 61: Line 75:




==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;" | '''ShowProperty'''
|-
| colspan="2" | Sets the labels to show a named property of each 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;" | '''ShowNames'''
|-
| colspan="2" | Sets the labels to show the names of objects. 
|-
|-
| 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 all labels. 
|-
|-
| 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;"
 
 
 
==Macro reference==
 
===Hide===
{| 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;" | '''SetTarget'''
| width="90%" class="mtx-class-macrohead" | '''Hide'''
|-
|-
| colspan="2" | Set the target object.  All items within the scope of this object will be given labels, not the taget object itself.  If the target is set to zero or 'this', all objects in the  current scope will be labelled. 
| colspan="2" | Hides all labels. 
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | target
|-
|-
| colspan="2" |  
|-
|-
| 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 125: Line 101:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetColor===
{| 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;" | '''SetColor'''
| width="90%" class="mtx-class-macrohead" | '''SetColor'''
|-
|-
| colspan="2" | Sets the color of the labels.  Note that this affects all nesting levels, so any nesting level specific colors set in the properties panel will be overridden. 
| colspan="2" | Sets the color of the labels.  Note that this affects all nesting levels, so any nesting level specific colors set in the properties panel will be overridden. 
Line 143: Line 120:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetTarget===
{| 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" | '''SetTarget'''
|-
|-
| colspan="2" | Refresh the labels after a change. 
| colspan="2" | Set the target object.  All items within the scope of this object will be given labels, not the taget object itself.  If the target is set to zero or 'this', all objects in the  current scope will be labelled. 
|-
|-
|-
|-
| 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%" | target
|}
 
 
 
 
==Property reference==
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| colspan="2" |  
| 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 labels to show... None - no labels are displayed Name - shows each component's name Property - shows a particular property of each component (see 'property' below. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto Update
|-
| colspan="2" | Automatically update the labels whenever panel items are added, deleted or re-named. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto Target
|-
| colspan="2" | When auto target is on, the auto labeller will label every item in its own context. When off, the "SetTarget" macro must be used to set the scope of the labeller. 
|-
| 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 labels 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' is chosen, you will be able to enter manual offsets along each axis. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Nesting
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Nesting
|-
| colspan="2" | Whether to label child items of groups, groups within groups etc. Off - only items at the same level as the labeller get labelled. Nest levels - how many 'generations' to iterate into groups. Show Leaves - does not label groups, but labels all individual items, no matter how far nested.  
|}==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;" | '''ShowProperty'''
|-
| colspan="2" | Sets the labels to show a named property of each 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 251: Line 139:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ShowNames===
{| 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;" | '''ShowNames'''
| width="90%" class="mtx-class-macrohead" | '''ShowNames'''
|-
|-
| colspan="2" | Sets the labels to show the names of objects. 
| colspan="2" | Sets the labels to show the names of objects. 
Line 264: Line 153:




{| 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;" | '''Hide'''
| width="90%" class="mtx-class-macrohead" | '''ShowProperty'''
|-
|-
| colspan="2" | Hides all labels. 
| colspan="2" | Sets the labels to show a named property of each object. 
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | Property
|}
 
 
{| 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" | Name of the property to show. 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTarget'''
|-
| colspan="2" | Set the target object.  All items within the scope of this object will be given labels, not the taget object itself.  If the target is set to zero or 'this', all objects in the  current scope will be labelled. 
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | target
|-
| colspan="2" |  
|-
|-
| 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 295: Line 172:




{| 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;" | '''SetColor'''
| width="90%" class="mtx-class-macrohead" | '''Update'''
|-
| colspan="2" | Sets the color of the labels.  Note that this affects all nesting levels, so any nesting level specific colors set in the properties panel will be overridden. 
|-
|-
| 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;" | '''Update'''
|-
|-
| colspan="2" | Refresh the labels after a change. 
| colspan="2" | Refresh the labels after a change. 
Line 324: Line 184:
| 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 351: Line 209:
| colspan="2" | When auto target is on, the auto labeller will label every item in its own context. When off, the "SetTarget" macro must be used to set the scope of the labeller. 
| colspan="2" | When auto target is on, the auto labeller will label every item in its own context. When off, the "SetTarget" macro must be used to set the scope of the labeller. 
|-
|-
| 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 370: Line 228:
| colspan="2" | Whether labels should always be draw on top of other objects. 
| 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="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 384: Line 242:
| colspan="2" | Whether labels get bigger and smaller when the panel is zoomed in and out. 
| 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="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
|-
|-
|-
|-
Line 393: Line 251:
| 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' is chosen, you will be able to enter manual offsets along each axis. 
| 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' is chosen, you will be able to enter manual offsets along each axis. 
|-
|-
| 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;" | Nesting
| width="90%" class="mtx-class-propfolder" | Nesting
|-
|-
|-
|-

Latest revision as of 14:37, 13 July 2026

Author Matrix Ltd.
Version 1.2
Category Misc


Component Labels component

Automatically generates labels for all panel objects and components in a given context. Labels will always face the camera, and can show the name of each object, or any chosen property. Nesting can be used so that components within components are labelled, and so on.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

Hide

Hide
Hides all labels. 
- VOID Return


SetColor

SetColor
Sets the color of the labels. Note that this affects all nesting levels, so any nesting level specific colors set in the properties panel will be overridden. 
- ULONG Color
Color to set the labels to. 
- VOID Return


SetTarget

SetTarget
Set the target object. All items within the scope of this object will be given labels, not the taget object itself. If the target is set to zero or 'this', all objects in the current scope will be labelled. 
- HANDLE target
 
- VOID Return


ShowNames

ShowNames
Sets the labels to show the names of objects. 
- VOID Return


ShowProperty

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


Update

Update
Refresh the labels after a change. 
- VOID Return


Property reference

Properties
Show
Decide what labels to show... None - no labels are displayed Name - shows each component's name Property - shows a particular property of each component (see 'property' below. 
Auto Update
Automatically update the labels whenever panel items are added, deleted or re-named. 
Auto Target
When auto target is on, the auto labeller will label every item in its own context. When off, the "SetTarget" macro must be used to set the scope of the labeller. 
Appearance
Color
Color of the labels 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' is chosen, you will be able to enter manual offsets along each axis. 
Nesting
Nesting
Whether to label child items of groups, groups within groups etc. Off - only items at the same level as the labeller get labelled. Nest levels - how many 'generations' to iterate into groups. Show Leaves - does not label groups, but labels all individual items, no matter how far nested.  
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Component_Labels_(Misc)&oldid=48064"