Jump to content

Array class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
VisualWikitext
mNo edit summary
Replaced with template tables
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide Array Properties Table</span>
{{VIServerClassTables|14}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Array Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#D1BB80;"
|6338C0D
| [[Array class/AdaptToSource property|AdaptToSource]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|6338C07
| [[Array class/ArrElem property|ArrElem]]
|Reference to the array element. The properties of the array apply to all elements in the array. If you want to read the data value of a specific array element, use the Index Array function to index the array first.
|R
|X
|- style="background-color:#D1BB80;"
|6338C09
| [[Array class/DimSizes property|DimSizes]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|6338C0B
| [[Array class/HorizScroll property|HorizScroll]]
|If TRUE, displays the horizontal scroll bar.
 
If the array has only one dimension and you resize it vertically on the front panel, writing this property has no effect.
 
This property is similar to the <b>Visible Items&#0187;</b>Horizontal Scrollbar item on the shortcut menu of an array and the <b>Show horizontal scroll bar</b> option on the Appearance page of the <b>Array Properties</b> dialog box.
|R/W
|X
|- style="background-color:#D1BB80;"
|6338C0C
| [[Array class/IndexRect property|IndexRect]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|6338C04
| [[Array class/IndexVals property|IndexVals]]
|Array of indexes (one per dimension) of element displayed in the top left corner of the array.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6338C03
| [[Array class/IndexVis property|IndexVis]]
|Shows array index.
 
This property is similar to the Visible Items&#0187;Index Display item on the shortcut menu of an array.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6338C08
| [[Array class/NumDims property|NumDims]]
|Gets or sets the number of dimensions in the array.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6338C01
| [[Array class/NumCols property|NumCols]]
|Number of visible columns in the array.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6338C02
| [[Array class/NumRows property|NumRows]]
|Returns the number of visible rows in the array.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6338C06
| [[Array class/SelSize() property|SelSize()]]
|Array of number of elements selected in each dimension (zero selected is insertion point).
|R/W
|X
|- style="background-color:#FFFFCC;"
|6338C05
| [[Array class/SelStart() property|SelStart()]]
|Returns an array of the indexes for each dimension that specifies the beginning of data selection.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6338C0A
| [[Array class/VertScroll property|VertScroll]]
|If TRUE, displays the vertical scroll bar.
 
If the array has only one dimension and you resize it horizontally on the front panel, writing this property has no effect. This property is similar to the <b>Visible Items&#0187;Vertical Scrollbar</b> item on the shortcut menu of an array and the <b>Show vertical scroll bar</b> option on the Appearance page of the <b>Array Properties</b> dialog box.
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide Array Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ Array Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|6338800
| [[Array class/Export Data to Clipboard method|Export Data to Clipboard]]
|Exports the array data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.
|X
|- style="background-color:#FFFFCC;"
|6338801
| [[Array class/Export Data to Excel method|Export Data to Excel]]
|Exports the array data to Excel.
|X
|}
</div>
 
==Events==
''No Events for this class.''


== 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 21:40, 8 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Array class
Class ID 14
Scope Basic Development Environment
Class Inheritance
Class Children

This class has no children.


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

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

Properties

Show/Hide Array Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Array Properties Table
Property ID Long Name (English) Description R/W RTE
6338C01Number of ColumnsNumber of visible columns in the array.Read/WriteYes
6338C02Number of RowsReturns the number of visible rows in the array.Read/WriteYes
6338C03Index VisibleShows array index.Read/WriteYes
6338C04Index ValuesArray of indexes (one per dimension) of element displayed in the top left corner of the array.Read/WriteYes
6338C05Selection Start[]Returns an array of the indexes for each dimension that specifies the beginning of data selection.Read/WriteYes
6338C06Selection Size[]Array of number of elements selected in each dimension (zero selected is insertion point).Read/WriteYes
6338C07Array ElementReference to the array element. The properties of the array apply to all elements in the array. If you want to read the data value of a specific array element, use the Index Array function to index the array first.Read OnlyYes
6338C08Number Of DimensionsGets or sets the number of dimensions in the array.Read/WriteYes (Read Only)
6338C09Dimension SizesRead/WriteYes
6338C0AVertical Scrollbar VisibleIf TRUE, displays the vertical scroll bar.Read/WriteYes
6338C0BHorizontal Scrollbar VisibleIf TRUE, displays the horizontal scroll bar.Read/WriteYes
6338C0CIndex RectRead OnlyYes
6338C0DAdapt To SourceRead/WriteYes

Methods

Show/Hide Array Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Array Methods Table
Method ID Long Name (English) Description RTE
6338800Export Data to ClipboardExports the array data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.Yes (Read/Write)
6338801Export Data to ExcelExports the array data to Excel.Yes (Read/Write)

Events

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


History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=Array_class&oldid=9740"