Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

gpeInsertEmptyColumns

gpeInsertEmptyColumns(
u_sandbox
t_direction
x_startColumn
[ ?count n_count ]
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Inserts empty columns in the specified Modgen sandbox object in the specified direction, starting at the specified column.

Arguments

u_sandbox

Specifies the Modgen sandbox object in which empty columns are to be inserted.

t_direction

Specifies the direction in which the additional columns are to be inserted relative to the start column.

Valid options are left and right.

x_startColumn

Specifies the reference column for inserting new columns. The column indexes start at 0.

?count n_count

Specifies the number of columns to be inserted. The default value is 1.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

t

Empty columns were inserted as specified.

nil

The command was unsuccessful.

Examples

Inserts 5 empty columns after the last column.

sbox = [create and populate a sandbox]
gpeInsertEmptyColumns(sbox "right" difference(gpeGetGridColCount(sbox) 1) ?count 5)

Inserts 5 empty columns to the left.

gpeInsertEmptyColumns(sbox "left" 0 ?count 5)

Inserts 1 empty column to the left of the 4th column, between columns indexed as 2 and 3.

;; (index 3 is the 4th column)
gpeInsertEmptyColumns(sbox "left" 3)

Inserts one column to the right of the third column, between columns indexed as 2 and 3.

;; (index 2 is the 3rd column)
gpeInsertEmptyColumns(sbox "right" 2)

Return to top
 ⠀
X