Jump to content

Array class: Difference between revisions

From LabVIEW Wiki
← Older edit
VisualWikitext
Replaced with template tables
Removed template
 
(2 intermediate revisions by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
== Properties ==
{{VIServerClassTables|14}}
<span class="mw-customtoggle-propertiestable">Show/Hide Array Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
|+ Array Properties Table
! data-sort-type="number"| Property ID
! Long Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
| data-sort-value=104041473 |6338C01
| [[Array class/Number of Columns property|Number of Columns]]
| Number of visible columns in the array.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104041474 |6338C02
| [[Array class/Number of Rows property|Number of Rows]]
| Returns the number of visible rows in the array.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104041475 |6338C03
| [[Array class/Index Visible property|Index Visible]]
| Shows array index.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104041476 |6338C04
| [[Array class/Index Values property|Index Values]]
| Array of indexes (one per dimension) of element displayed in the top left corner of the array.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104041477 |6338C05
| [[Array class/Selection Start() property|Selection Start[]]]
| Returns an array of the indexes for each dimension that specifies the beginning of data selection.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104041478 |6338C06
| [[Array class/Selection Size() property|Selection Size[]]]
| Array of number of elements selected in each dimension (zero selected is insertion point).
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104041479 |6338C07
| [[Array class/Array Element property|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
|- style="background-color:#CCFFFF;"
| data-sort-value=104041480 |6338C08
| [[Array class/Number Of Dimensions property|Number Of Dimensions]]
| Gets or sets the number of dimensions in the array.
| Read/Write
| Yes (Read Only)
|- style="background-color:#D1BB80;"
| data-sort-value=104041481 |6338C09
| [[Array class/Dimension Sizes property|Dimension Sizes]]
|
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104041482 |6338C0A
| [[Array class/Vertical Scrollbar Visible property|Vertical Scrollbar Visible]]
| If TRUE, displays the vertical scroll bar.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104041483 |6338C0B
| [[Array class/Horizontal Scrollbar Visible property|Horizontal Scrollbar Visible]]
| If TRUE, displays the horizontal scroll bar.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104041484 |6338C0C
| [[Array class/Index Rect property|Index Rect]]
| Returns the coordinates of the rectangle that encloses the index display on the array.
| Read Only
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104041485 |6338C0D
| [[Array class/Adapt To Source property|Adapt To Source]]
|
| Read/Write
| Yes
|}
</div></div>
 
== Methods ==
<span class="mw-customtoggle-methodstable">Show/Hide Array Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
|+ Array Methods Table
! data-sort-type="number"| Property ID
! Long Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
| data-sort-value=104040448 |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.
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=104040449 |6338801
| [[Array class/Export Data to Excel method|Export Data to Excel]]
| Exports the array data to Excel.
| Yes
|}
</div></div>
 
== Events ==
''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 occurred 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 25: 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"