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

schSetPropertyDisplay

schSetPropertyDisplay( 
?object d_object
[?name S_name]
?visibility S_visibility
)
=> l_textDisplays / nil

Description

Shows or hides textDisplays containing the name and value of the attribute, property, or parameter of an object. TextDisplay locations are chosen automatically to avoid overlaps with other textDisplays. For more information, see schGetPropertyDisplay and dbCreateTextDisplay.

Arguments

?object d_object

The object whose attribute, property, or parameter you want to display. Supported objects are: instance, textDisplay.

?name S_name

Name of the attribute, property, or parameter of d_object whose display characteristics you want to change. The supported values depend on the type of d_object. Refer to the following t_name values for d_object.

d_object type - t_name

Instance - libName, cellName, viewName, name;

The name of any property on the instance; the name of any CDF parameter on the instance; nil to manipulate all textDisplays owned by the instance.

textDisplay - nil

The textDisplay's name and value settings can be changed directly by s_visibility.

?visibility S_visibility

Values for this argument:

'off hides the element from view, but does not delete it

'name shows only the name of the element, for example, cellName

'value shows only the value of the element, for example, nmos

'both shows both the element name and value, for example, cellName=nmos

'off does not delete a textDisplay. If you subsequently make it visible, it appears at its previous location. To completely delete a textDisplay, use schDelete.

Return Value

l_textDisplays

A list of existing or newly created textDisplay objects that display the requested property. Usually, there is only one such textDisplay.

nil

If the requested property could not be displayed.

Examples

Displays the favorite items for an instance

schSetPropertyDisplay(?object inst
     ?name "name"
     ?visibility 'both)
schSetPropertyDisplay(?object inst
     ?name "cellName"
     ?visibility 'value)
schSetPropertyDisplay(?object inst
      ?name "vdd"
      ?visibility 'both)
schSetPropertyDisplay(?object inst
     ?name "model"
     ?visibility 'value)

Turns on all netSet properties for an instance.

foreach(netSet setof(prop
     inst->prop
     prop->valueType == "netSet")
schSetPropertyDisplay(?object inst
     ?name netSet->name
     ?visibility 'both)
)

Switches off all displayed properties on an instance

schSetPropertyDisplay(?object inst ?visibility 'off)

Permanently removes all 'off displayed properties

foreach(td schGetPropertyDisplay(?object inst)
when(schGetPropertyDisplay(?object td) == 'off
schDelete(td)
)
)

Related Topics

schGetPropertyDisplay

dbCreateTextDisplay

schDelete


Return to top
 ⠀
X