Difference between revisions of "Component: Component Labels (Advanced Shapes)"
From Flowcode Help
Jump to navigationJump to search| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 32: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 164: | Line 168: | ||
|- | |- | ||
| 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="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| Line 179: | Line 187: | ||
|- | |- | ||
| 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="90%" style="background-color:#EAE1EA; color:#4B008D;" | Size | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| Line 189: | Line 201: | ||
|- | |- | ||
| 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="90%" style="background-color:#EAE1EA; color:#4B008D;" | Offset | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| Line 194: | Line 210: | ||
|- | |- | ||
| 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="90%" style="background-color:#EAE1EA; color:#4B008D;" | Nesting | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| Line 199: | Line 219: | ||
|- | |- | ||
| 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. | | 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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Latest revision as of 17:25, 9 November 2022
| Author | Matrix Ltd. |
| Version | 1.2 |
| Category | Advanced Shapes |
Contents
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 Pack
FREE
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
ShowProperty |
| Sets the labels to show a named property of each object. | |
 - STRING
|
Property |
| Name of the property to show. | |
 - VOID
|
Return |
|
|
ShowNames |
| Sets the labels to show the names of objects. | |
| - VOID
|
Return |
|
|
Hide |
| Hides all labels. | |
| - VOID
|
Return |
|
|
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 |
|
|
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 |
|
|
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. | |
