Jump to content

ArrayConstant class: Difference between revisions

From LabVIEW Wiki
← Older edit
Visual
m Added VI Scripting Class Category to page
Removed template
 
(3 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|16388}}
<span class="mw-customtoggle-propertiestable">Show/Hide ArrayConstant 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"
|+ ArrayConstant Properties Table
! data-sort-type="number"| Property ID
! Long Name (English)
! Description
! R/W
! RTE
|- style="background-color:#CCFFFF;"
| data-sort-value=104121344 |634C400
| [[ArrayConstant class/Num Dimensions property|Num Dimensions]]
| Returns the number of dimensions in the array.
| Read/Write
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=104121345 |634C401
| [[ArrayConstant class/Element Gap? property|Element Gap?]]
| Returns TRUE if there is a gap between elements of the array.
| Read/Write
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=104121346 |634C402
| [[ArrayConstant class/Number of Columns property|Number of Columns]]
| Returns the number of visible columns in the array.
| Read/Write
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=104121347 |634C403
| [[ArrayConstant class/Number of Rows property|Number of Rows]]
| Returns the number of visible rows in the array.
| Read/Write
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=104121348 |634C404
| [[ArrayConstant class/Index Visible? property|Index Visible?]]
| Returns TRUE if the array index is visible.
| Read/Write
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=104121349 |634C405
| [[ArrayConstant class/Index Value property|Index Value]]
| Returns an array of indices for the element displayed in the top left corner of the array of each dimension.
| Read/Write
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=104121350 |634C406
| [[ArrayConstant class/Selection Start() property|Selection Start[]]]
| Returns an array of the indexes for each dimension that specifies the beginning of data selection.
| Read/Write
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=104121351 |634C407
| [[ArrayConstant class/Selection End() property|Selection End[]]]
| Returns an array of the number of elements you select in each dimension of the array.
| Read/Write
| No
|- style="background-color:#CCFFFF;"
| data-sort-value=104121352 |634C408
| [[ArrayConstant class/Element property|Element]]
| Returns a reference to an array element.
| Read Only
| No
|- style="background-color:#D1BB80;"
| data-sort-value=104121353 |634C409
| [[ArrayConstant class/Dimension Sizes property|Dimension Sizes]]
|
| Read/Write
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104121354 |634C40A
| [[ArrayConstant class/Show Selection? property|Show Selection?]]
| Returns TRUE if the selected elements of the array are visible.
| Read/Write
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104121355 |634C40B
| [[ArrayConstant class/Vertical Scrollbar Visible property|Vertical Scrollbar Visible]]
| Returns TRUE if the vertical scrollbar is visible.
| Read/Write
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104121356 |634C40C
| [[ArrayConstant class/Horizontal Scrollbar Visible property|Horizontal Scrollbar Visible]]
| Returns TRUE if the horizontal scroll bar is visible.
| Read/Write
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104121357 |634C40D
| [[ArrayConstant 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=104121358 |634C40E
| [[ArrayConstant class/Adapt To Source property|Adapt To Source]]
|
| Read/Write
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104121359 |634C40F
| [[ArrayConstant class/FPGA Implementation property|FPGA Implementation]]
|
| Read/Write
| Yes
|- style="background-color:#D1BB80;"
| data-sort-value=104121360 |634C410
| [[ArrayConstant class/FPGA Enable Out of Bounds MUX property|FPGA Enable Out of Bounds MUX]]
|
| Read/Write
| Yes
|}
</div></div>
 
== Methods ==
<span class="mw-customtoggle-methodstable">Show/Hide ArrayConstant 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"
|+ ArrayConstant Methods Table
! data-sort-type="number"| Property ID
! Long Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
| data-sort-value=104120320 |634C000
| [[ArrayConstant class/Empty Array method|Empty Array]]
| Deletes all the elements in an array.
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104120321 |634C001
| [[ArrayConstant class/Insert Row Before method|Insert Row Before]]
| Inserts a row before the index you specify. This method applies only to 2D arrays.
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104120322 |634C002
| [[ArrayConstant class/Insert Column Before method|Insert Column Before]]
| Inserts a column before the index you specify. This method applies only to 2D arrays.
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104120323 |634C003
| [[ArrayConstant class/Delete Row method|Delete Row]]
| Deletes a row at the index you specify. This method applies only to 2D arrays.
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104120324 |634C004
| [[ArrayConstant class/Delete Column method|Delete Column]]
| Deletes a column at the index you specify. This method applies only to 2D arrays.
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104120325 |634C005
| [[ArrayConstant class/Insert Element Before method|Insert Element Before]]
| Inserts an element before the index you specify. This method applies only to 1D arrays.
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=104120326 |634C006
| [[ArrayConstant class/Delete Element method|Delete Element]]
| Deletes an element at the index you specify. This method applies only to 1D arrays.
| Yes
|}
</div></div>
 
== Events ==
''This class has no events or it inherits events from its parent: [[Constant class#Events|Constant 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 [[ArrayConstant class/Index Rect property|Index Rect property]] was changed from being [[VI Server#Private|Private]] to [[VI Server#VI Scripting|VI Scripting]].
|}
|}


Line 24: Line 189:
*[[VI Server]]
*[[VI Server]]
*[[VI Scripting]]
*[[VI Scripting]]
[[Category:VI Scripting Class]]
[[Category:VI Scripting Class]]
[[Category:VI Server]]
[[Category:VI Server Class]]
[[Category:VI Server Class]]
[[Category:VI Scripting]]

Latest revision as of 23:33, 14 June 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name ArrayConstant class
Class ID 16388
Scope VI Scripting
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 ArrayConstant class is a class in the VI Server Class Hierarchy, (see also VI Server).

    Properties

    Show/Hide ArrayConstant Properties Table

    Legend
    R/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    ArrayConstant Properties Table
    Property ID Long Name (English) Description R/W RTE
    634C400 Num Dimensions Returns the number of dimensions in the array. Read/Write No
    634C401 Element Gap? Returns TRUE if there is a gap between elements of the array. Read/Write No
    634C402 Number of Columns Returns the number of visible columns in the array. Read/Write No
    634C403 Number of Rows Returns the number of visible rows in the array. Read/Write No
    634C404 Index Visible? Returns TRUE if the array index is visible. Read/Write No
    634C405 Index Value Returns an array of indices for the element displayed in the top left corner of the array of each dimension. Read/Write No
    634C406 Selection Start[] Returns an array of the indexes for each dimension that specifies the beginning of data selection. Read/Write No
    634C407 Selection End[] Returns an array of the number of elements you select in each dimension of the array. Read/Write No
    634C408 Element Returns a reference to an array element. Read Only No
    634C409 Dimension Sizes Read/Write Yes
    634C40A Show Selection? Returns TRUE if the selected elements of the array are visible. Read/Write Yes
    634C40B Vertical Scrollbar Visible Returns TRUE if the vertical scrollbar is visible. Read/Write Yes
    634C40C Horizontal Scrollbar Visible Returns TRUE if the horizontal scroll bar is visible. Read/Write Yes
    634C40D Index Rect Returns the coordinates of the rectangle that encloses the index display on the array. Read Only Yes
    634C40E Adapt To Source Read/Write Yes
    634C40F FPGA Implementation Read/Write Yes
    634C410 FPGA Enable Out of Bounds MUX Read/Write Yes

    Methods

    Show/Hide ArrayConstant Methods Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    ArrayConstant Methods Table
    Property ID Long Name (English) Description RTE
    634C000 Empty Array Deletes all the elements in an array. Yes
    634C001 Insert Row Before Inserts a row before the index you specify. This method applies only to 2D arrays. Yes
    634C002 Insert Column Before Inserts a column before the index you specify. This method applies only to 2D arrays. Yes
    634C003 Delete Row Deletes a row at the index you specify. This method applies only to 2D arrays. Yes
    634C004 Delete Column Deletes a column at the index you specify. This method applies only to 2D arrays. Yes
    634C005 Insert Element Before Inserts an element before the index you specify. This method applies only to 1D arrays. Yes
    634C006 Delete Element Deletes an element at the index you specify. This method applies only to 1D arrays. Yes

    Events

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

    History

    Version Change(s)
    LabVIEW 2020 In LabVIEW 2020 the Index Rect property was changed from being Private to VI Scripting.

    See Also

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