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

gpeGetChannelWidthEntry

gpeGetChannelWidthEntry(
u_sandbox
x_channelNumber
t_direction
[ ?verbose { t | nil } ]
)
=> g_ChannelWidthEntry / nil

Description

Returns the channelWidth sandbox object that matches the specified index and direction values.

Arguments

u_sandbox

Specifies a Modgen sandbox object.

x_channelNumber

Specifies the row or column number in which the channelWidth sandbox object is located.

t_direction

Specifies the direction of the channelWidth sandbox object. Valid values are: horizontal and vertical.

?verbose { t | nil }

Controls the display of warning messages.

Value Returned

g_ChannelWidthEntry

Returns a Modgen channel width object that has properties: width and reference.

Example:

(nil 0.8 "Active")

nil

The command was unsuccessful.

Example

Retrieves the channel width from the first horizontal channel in the specified Modgen sandbox object.

sandbox = gpeEditSandbox(leGetEditFigGroup())
channelWidth = gpeGetChannelWidthEntry(sandbox 1 "horizontal")

Return to top
 ⠀
X