API System.ShowHandle: Difference between revisions

Revision as of 10:52, 1 July 2013

<sidebar>API contents</sidebar> Given a handle to an object with viewable presence, shows that object on screen

HANDLE Handle

The object to display on screen

Returns true if the operation is a success, else false

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

No additional examples

@@ Line 23: / Line 23: @@
 ==Detailed description==
-''<span style="color:red;">No additional information</span>''
+This tells Flowcode to show whatever object is represented by ''Handle''.
+The types of object that are supported are:
+{| class="wikitable"
+|-
+!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
+|}