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

gpeClearChannelWidthEntry

gpeClearChannelWidthEntry(
u_sandbox
x_index
t_direction
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Clears the channelWidth value of the specified channel in the specified sandbox.

Arguments

u_sandbox

Specifies the Modgen sandbox object.

x_index

Specifies a channel number.

t_direction

Indicates the direction of the channelWidth sandbox entry. Valid values are horizontal and vertical.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

t

The channelWidth was deleted.

nil

The command was unsuccessful.

Example

In the following example, the channelWidth value of the specified channel in the specified sandbox is deleted.

sandbox = gpeEditSandbox(leGetEditFigGroup())
gpeClearChannelWidthEntry(sandbox 1 "horizontal")

Return to top
 ⠀
X