Jump to content

Array class: Difference between revisions

From LabVIEW Wiki
← Older edit
VisualWikitext
mNo edit summary
Removed template
 
(3 intermediate revisions by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
== Properties ==
<span class="mw-customtoggle-propertiestable">Show/Hide Array Properties Table</span>
<span class="mw-customtoggle-propertiestable">Show/Hide Array Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"  
|+ Array Properties Table
|+ Array Properties Table
! Property ID
! data-sort-type="number"| Property ID
! Short Name (English)
! Long Name (English)
! Description
! Description
! R/W
! R/W
! RTE
! RTE  
|- style="background-color:#D1BB80;"
|- style="background-color:#FFFFCC;"  
|6338C0D
| data-sort-value=104041473 |6338C01
| [[Array class/AdaptToSource property|AdaptToSource]]
| [[Array class/Number of Columns property|Number of Columns]]
|
| Number of visible columns in the array.
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|6338C07
| data-sort-value=104041474 |6338C02
| [[Array class/ArrElem property|ArrElem]]
| [[Array class/Number of Rows property|Number of Rows]]
|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.
| Returns the number of visible rows in the array.
|R
| Read/Write
|X
| Yes
|- style="background-color:#D1BB80;"
|- style="background-color:#FFFFCC;"  
|6338C09
| data-sort-value=104041475 |6338C03
| [[Array class/DimSizes property|DimSizes]]
| [[Array class/Index Visible property|Index Visible]]
|
| Shows array index.
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|6338C0B
| data-sort-value=104041476 |6338C04
| [[Array class/HorizScroll property|HorizScroll]]
| [[Array class/Index Values property|Index Values]]
|If TRUE, displays the horizontal scroll bar.
| Array of indexes (one per dimension) of element displayed in the top left corner of the array.
 
| Read/Write
If the array has only one dimension and you resize it vertically on the front panel, writing this property has no effect.
| Yes
 
|- style="background-color:#FFFFCC;"  
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.
| data-sort-value=104041477 |6338C05
|R/W
| [[Array class/Selection Start() property|Selection Start[]]]
|X
| Returns an array of the indexes for each dimension that specifies the beginning of data selection.
|- style="background-color:#D1BB80;"
| Read/Write
|6338C0C
| Yes
| [[Array class/IndexRect property|IndexRect]]
|- style="background-color:#FFFFCC;"  
|
| data-sort-value=104041478 |6338C06
|R
| [[Array class/Selection Size() property|Selection Size[]]]
|X
| Array of number of elements selected in each dimension (zero selected is insertion point).
|- style="background-color:#FFFFCC;"
| Read/Write
|6338C04
| Yes
| [[Array class/IndexVals property|IndexVals]]
|- style="background-color:#FFFFCC;"  
|Array of indexes (one per dimension) of element displayed in the top left corner of the array.
| data-sort-value=104041479 |6338C07
|R/W
| [[Array class/Array Element property|Array Element]]
|X
| 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.
|- style="background-color:#FFFFCC;"
| Read Only
|6338C03
| Yes
| [[Array class/IndexVis property|IndexVis]]
|- style="background-color:#CCFFFF;"  
|Shows array index.
| data-sort-value=104041480 |6338C08
 
| [[Array class/Number Of Dimensions property|Number Of Dimensions]]
This property is similar to the Visible Items&#0187;Index Display item on the shortcut menu of an array.
| Gets or sets the number of dimensions in the array.
|R/W
| Read/Write
|X
| Yes (Read Only)
|- style="background-color:#CCFFFF;"
|- style="background-color:#D1BB80;"  
|6338C08
| data-sort-value=104041481 |6338C09
| [[Array class/NumDims property|NumDims]]
| [[Array class/Dimension Sizes property|Dimension Sizes]]
|Gets or sets the number of dimensions in the array.
|  
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|6338C01
| data-sort-value=104041482 |6338C0A
| [[Array class/NumCols property|NumCols]]
| [[Array class/Vertical Scrollbar Visible property|Vertical Scrollbar Visible]]
|Number of visible columns in the array.
| If TRUE, displays the vertical scroll bar.
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|6338C02
| data-sort-value=104041483 |6338C0B
| [[Array class/NumRows property|NumRows]]
| [[Array class/Horizontal Scrollbar Visible property|Horizontal Scrollbar Visible]]
|Returns the number of visible rows in the array.
| If TRUE, displays the horizontal scroll bar.
|R/W
| Read/Write
|X
| Yes
|- style="background-color:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|6338C06
| data-sort-value=104041484 |6338C0C
| [[Array class/SelSize() property|SelSize()]]
| [[Array class/Index Rect property|Index Rect]]
|Array of number of elements selected in each dimension (zero selected is insertion point).
| Returns the coordinates of the rectangle that encloses the index display on the array.
|R/W
| Read Only
|X
| Yes
|- style="background-color:#FFFFCC;"
|- style="background-color:#D1BB80;"  
|6338C05
| data-sort-value=104041485 |6338C0D
| [[Array class/SelStart() property|SelStart()]]
| [[Array class/Adapt To Source property|Adapt To Source]]
|Returns an array of the indexes for each dimension that specifies the beginning of data selection.
|  
|R/W
| Read/Write
|X
| Yes
|- 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>
</div></div>


==Methods==
== Methods ==
<span class="mw-customtoggle-methodstable">Show/Hide Array Methods Table</span>
<span class="mw-customtoggle-methodstable">Show/Hide Array Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{{VIServerLegend|showrte=TRUE}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
{| class="wikitable sortable"
|+ Array Methods Table
|+ Array Methods Table
! Method ID
! data-sort-type="number"| Property ID
! Short Name (English)
! Long Name (English)
! Description
! Description
! RTE
! RTE  
|- style="background-color:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|6338800
| data-sort-value=104040448 |6338800
| [[Array class/Export Data to Clipboard method|Export Data to Clipboard]]
| [[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.
| Exports the array data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.
|X
| Yes
|- style="background-color:#FFFFCC;"
|- style="background-color:#FFFFCC;"  
|6338801
| data-sort-value=104040449 |6338801
| [[Array class/Export Data to Excel method|Export Data to Excel]]
| [[Array class/Export Data to Excel method|Export Data to Excel]]
|Exports the array data to Excel.
| Exports the array data to Excel.
|X
| Yes
|}
|}
</div>
</div></div>


==Events==
== Events ==
''No Events for this class.''
''This class has no events or it inherits events from its parent: [[Control class#Events|Control Class]].''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
! Change(s)
! Change(s)
|-
|-
|[[File:LV2018.png|frameless|border|64x64px|LabVIEW 2018|link=LabVIEW 2018]]
|[[File:LV2020.png|frameless|border|64x64px|LabVIEW 2020|link=LabVIEW 2020]]
|More info to come.
| In [[LabVIEW 2020]] the [[Array class/Index Rect property|Index Rect property]] changed from being [[VI Server#Private|Private]] to being part of the [[VI Server#Basic Development Environment|Basic Development Environment]].
|}
|}


Line 148: Line 141:
*[[VI Scripting]]
*[[VI Scripting]]


[[Category:VI Server]]
[[Category:VI Server Class]]
[[Category:VI Server Class]]
[[Category:VI Scripting]]

Latest revision as of 14:24, 14 June 2020

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
6338C01 Number of Columns Number of visible columns in the array. Read/Write Yes
6338C02 Number of Rows Returns the number of visible rows in the array. Read/Write Yes
6338C03 Index Visible Shows array index. Read/Write Yes
6338C04 Index Values Array of indexes (one per dimension) of element displayed in the top left corner of the array. Read/Write Yes
6338C05 Selection Start[] Returns an array of the indexes for each dimension that specifies the beginning of data selection. Read/Write Yes
6338C06 Selection Size[] Array of number of elements selected in each dimension (zero selected is insertion point). Read/Write Yes
6338C07 Array Element 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. Read Only Yes
6338C08 Number Of Dimensions Gets or sets the number of dimensions in the array. Read/Write Yes (Read Only)
6338C09 Dimension Sizes Read/Write Yes
6338C0A Vertical Scrollbar Visible If TRUE, displays the vertical scroll bar. Read/Write Yes
6338C0B Horizontal Scrollbar Visible If TRUE, displays the horizontal scroll bar. Read/Write Yes
6338C0C Index Rect Returns the coordinates of the rectangle that encloses the index display on the array. Read Only Yes
6338C0D Adapt To Source Read/Write Yes

Methods

Show/Hide Array Methods Table

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

Events

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

History

Version Change(s)
LabVIEW 2020 In LabVIEW 2020 the Index Rect property changed from being Private to being part of the Basic Development Environment.

See Also

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