Product Documentation
Virtuoso Schematic Editor SKILL Functions Reference
Product Version IC23.1, November 2023

schGetBundleDisplayMode 

schGetBundleDisplayMode( 
d_labelId 
)
=> vertical / horizontal / nil

Description

Takes a label Id and returns its display mode. This only works for label type objects. If the specified object Id is not a label object, then the API will return nil. This will only work when the cellview is editable.

Arguments

d_labelId

Label Id whose bundle display mode value, horizontal or vertical, is to be obtained.

Value Returned

vertical

Label Id display mode is set to vertical.

horizontal

Label Id display mode is set to horizontal.

nil

Object Id entered was not a label.

Examples

If labId represents a wire bundle label, which is being displayed vertically, then:

schGetBundleDisplayMode (labId) => “vertical”

If figId represents the Id of a pin name, then:

schGetBundleDisplayMode (figId) => nil

Return to top
 ⠀
X