lxUpdateGroupArrayParams
lxUpdateGroupArrayParams(
d_groupArrayId
[ ?rows x_rows ]
[ ?columns x_cols ]
[ ?X x_xValue ]
[ ?Y x_yValue ]
[ ?orients l_orientList ]
[ ?mode 'pitch | 'spacing ]
[ ?lpp l_refLPP ]
)
=> t / nil
Description
Updates the specified parameters of a group array.
Arguments
|
d_groupArrayId
|
Database ID of the group array to be updated.
|
|
?rows x_rows
|
Number of rows in the group array.
|
|
?columns x_cols
|
Number of columns in the group array.
|
|
?X x_xValue
|
Spacing added between group array cells in the X direction. Spacing is applied based on the specified mode.
|
|
?Y x_yValue
|
Spacing added between group array cells in the Y direction. Spacing is applied based on the specified mode.
|
|
?orients l_orientList
|
Orientation pattern used for the group array. If the pattern is smaller than the given rows and columns in the group array, the pattern is repeated from left to right and bottom to top. The bottom-most row in the pattern is considered as the first row.
|
|
?mode 'pitch | 'spacing
|
|
|
Mode used for applying spacing between group array cells. Valid values are 'pitch and 'spacing.
-
'
pitch: Lets you specify the distance that is measured between the same-edge corners of cells. For example, the distance between the left edges of two cell. -
'
spacing: Lets you specify the distance that is measured between the adjacent or closest edges of cells. For example, the distance between the top edge of a cell and the lower edge of another cell.
|
|
?lpp l_refLPP
|
Specifies the layer-purpose pair used for computing the bounding box of the cells in a group array. The combined bounding box of the geometries on the specified reference layer-purpose pair is used for calculating the spacing between cells.
|
Value Returned
|
t
|
Group array parameters updated successfully.
|
|
nil
|
Group array parameters could not be updated.
|
Example
The following code updates the row and column count and the X and Y spacing of the group array whose database ID is stored in groupArray1.
lxUpdateGroupArrayParams(groupArray1 ?rows 3 ?columns 3 ?X 4 ?Y 3)
==> t
Related Topics
Group Arrays
Group Array SKILL Functions
Return to top
