Jump to content

AbstractDiagram class: Difference between revisions

From LabVIEW Wiki
mNo edit summary
Replaced with template tables
Line 8: Line 8:


==Properties==
==Properties==
<span class="mw-customtoggle-propertiestable">Show/Hide AbstractDiagram Properties Table</span>
{{VIServerPropsTable|16503}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ AbstractDiagram Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
|6375804
| [[AbstractDiagram class/AllObjs() property|AllObjs()]]
|Provides an array of references to all the top-level objects in the block diagram.
|R
|
|- style="background-color:#CCFFFF;"
|637580A
| [[AbstractDiagram class/BreakPtStatus property|BreakPtStatus]]
|Reads or writes the status of a breakpoint on a diagram.
 
Valid values include Cleared, Enabled, and Disabled.
|R/W
|
|- style="background-color:#CCFFFF;"
|6375800
| [[AbstractDiagram class/Color property|Color]]
|Color of the diagram.
|R/W
|
|- style="background-color:#CCFFFF;"
|6375803
| [[AbstractDiagram class/Decos() property|Decos()]]
|Array of references to the top-level decorations in the diagram.
|R
|
|- style="background-color:#CCFFFF;"
|6375808
| [[AbstractDiagram class/FiringOrder property|FiringOrder]]
|Returns the firing order of the diagram as an array of nodes.  The property organizes the firing order from first to last.
|R
|X
|- style="background-color:#CCFFFF;"
|6375809
| [[AbstractDiagram class/Nodes() property|Nodes()]]
|Returns references to all the nodes in the diagram.
|R
|X
|- style="background-color:#CCFFFF;"
|6375802
| [[AbstractDiagram class/SubVIs() property|SubVIs()]]
|Provides an array of references to the top-level subVIs in the diagram.
|R
|
|- style="background-color:#CCFFFF;"
|637580B
| [[AbstractDiagram class/SubDiag Label property|SubDiag Label]]
|Returns a reference to the subdiagram label. If the structure does not have a subdiagram label, this property returns an error.
|R
|
|- style="background-color:#CCFFFF;"
|6375805
| [[AbstractDiagram class/Wires() property|Wires()]]
|Provides an array of references to all the wires connecting the top-level objects in the diagram.
|R
|
|}
</div>


==Methods==
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide AbstractDiagram Methods Table</span>
{{VIServerMethodsTable|16503}}
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ AbstractDiagram Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#D1BB80;"
|6375408
| [[AbstractDiagram class/BuildIGL method|BuildIGL]]
|
|
|- style="background-color:#D1BB80;"
|6375407
| [[AbstractDiagram class/Create Constant method|Create Constant]]
|
|
|- style="background-color:#D1BB80;"
|6375404
| [[AbstractDiagram class/Gen Script Diagram method|Gen Script Diagram]]
|
|
|- style="background-color:#D1BB80;"
|6375406
| [[AbstractDiagram class/GetCodeWizRef method|GetCodeWizRef]]
|
|
|- style="background-color:#CCFFFF;"
|6375402
| [[AbstractDiagram class/MakeSpace method|MakeSpace]]
|Move objects out in the specified direction to make space in a given location. The  top and left of the Rectangle specify the position in which to create space. The width and height of the Rectangle specify how much space to create.
|X
|- style="background-color:#CCFFFF;"
|6375400
| [[AbstractDiagram class/Paste method|Paste]]
|Pastes the clipboard contents at the specified location.
|
|- style="background-color:#CCFFFF;"
|6375409
| [[AbstractDiagram class/RemWireLooseEnds method|RemWireLooseEnds]]
|Traverses the referenced diagram and removes all wire ends that are not connected to anything.
|
|- style="background-color:#CCFFFF;"
|6375401
| [[AbstractDiagram class/Select All method|Select All]]
|Selects all objects in the diagram.
|
|- style="background-color:#CCFFFF;"
|6375403
| [[AbstractDiagram class/Shrink Wrap Structs method|Shrink Wrap Structs]]
|Shrink Wraps all structures on the diagram.  This method is recursive.
|X
|- style="background-color:#D1BB80;"
|6375405
| [[AbstractDiagram class/SubVI From Selection method|SubVI From Selection]]
|
|X
|}
</div>


==Events==
==Events==
''No Events for this class.''
{{VIServerEventsTable|16503}}


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version

Revision as of 16:34, 8 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name AbstractDiagram class
Class ID 16503
Scope VI Scripting
Class Inheritance
Class Children


The AbstractDiagram class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide AbstractDiagram Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
AbstractDiagram Properties Table
Property ID Long Name (English) Description R/W RTE
6375800ColorColor of the diagram.Read/WriteNo
6375801Functions[]Read OnlyNo
6375802SubVIs[]Provides an array of references to the top-level subVIs in the diagram.Read OnlyNo
6375803Decorations[]Array of references to the top-level decorations in the diagram.Read OnlyNo
6375804All Objects[]Provides an array of references to all the top-level objects in the block diagram.Read OnlyNo
6375805Wires[]Provides an array of references to all the wires connecting the top-level objects in the diagram.Read OnlyNo
6375806Is Break Point SetRead/WriteNo
6375808Firing OrderReturns the firing order of the diagram as an array of nodes. The property organizes the firing order from first to last.Read OnlyYes
6375809Nodes[]Returns references to all the nodes in the diagram.Read OnlyYes
637580ABreakpoint StatusReads or writes the status of a breakpoint on a diagram.Read/WriteNo
637580BSubdiagram LabelReturns a reference to the subdiagram label. If the structure does not have a subdiagram label, this property returns an error.Read OnlyNo


Methods

Show/Hide AbstractDiagram Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
AbstractDiagram Methods Table
Method ID Long Name (English) Description RTE
6375400PastePastes the clipboard contents at the specified location.No
6375401Select AllSelects all objects in the diagram.No
6375402Make SpaceMove objects out in the specified direction to make space in a given location. The top and left of the Rectangle specify the position in which to create space. The width and height of the Rectangle specify how much space to create.Yes (Read/Write)
6375403Shrink Wrap StructuresShrink Wraps all structures on the diagram. This method is recursive.Yes (Read/Write)
6375404Gen Script DiagramNo
6375405SubVI From SelectionYes
6375406Get CodeWizRefNo
6375407Create Constant From Data TypeNo
6375408Build IGLNo
6375409Remove Wire Loose EndsTraverses the referenced diagram and removes all wire ends that are not connected to anything.No


Events

This class has no events or it inherits events from its parent: GObject Class.


History

Version Change(s)
LabVIEW 2018 More info to come.

See Also