API System.ShowHandle: Difference between revisions
m Text replacement - "class="wikitable" style="width:60%; background-color:#FFFFFF;"" to "class="mtx-class-macrotable wikitable"" |
m Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;" align="center"" to "width="10%" align="center" class="mtx-class-macrohead"" |
||
| Line 1: | Line 1: | ||
{| class="mtx-class-macrotable wikitable" | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShowHandle''' | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShowHandle''' | ||
|- | |- | ||
Revision as of 14:08, 13 July 2026
|
ShowHandle |
| Given a handle to an object with viewable presence, shows that object on screen | |
 - HANDLE
|
Handle |
| The object to display on screen | |
 - BOOL
|
Return |
Detailed description
This tells Flowcode to show whatever object is represented by Handle.
The types of object that are supported are:
| Handle type | Result of this call |
|---|---|
| Component | Moves the camera in its current viewing plane over the components position
If the panel (system or dashboard) the component exists on is not shown, this will open that window |
| Position | Behaves as though a component, and moves the camera to look at that position |
| LinkBar | Behaves as though a component, and moves the camera to look at the center of the link |
| Point cloud | Behaves as though a component, and moves the camera to look at the center of the cloud |
| Console | Opens the console window and selects the appropriate console tab |
| Scope group/stream | Opens the data scope window to show the scope |
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::System.ShowHandle(handle)