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

pteToggleLSActive

pteToggleLSActive(
?layerSets t_layerSetName
[ ?toggleVis { t | nil } ]
[ ?toggleSel { t | nil } ]
[ w_windowId ]
)
=> t / nil

Description

Adds or removes the specified layer set from the list of active layer sets. Additionally, toggles the visibility and selectability status of the various layer-purpose pairs contained in the layer set.

Arguments

?layerSets t_layerSetName

Layer set name.

?toggleVis

If set to t, the visibility status of all layer-purpose pairs contained in the layer set is toggled.
If set to nil, the visibility of all layer-purpose pairs contained in the layer set remains unchanged.

?toggleSel

If set to t, the selectability status of all layer-purpose pairs contained in the layer set is toggled.
If set to nil, the selectability of all layer-purpose pairs contained in the layer set remains unchanged.

w_windowId

ID of the window containing the Palette that you want to update.
Valid values: ID of any open window
Default: Current window

Value Returned

t

The specified layer set was added or removed from the list of active layers and the visibility and selectability status was toggled as required.

nil

The command was unsuccessful.

Examples

pteToggleLSActive(?layerSet "All Layers" ?toggleVis t ?toggleSel nil)
pteToggleLSActive(?layerSet pteGetLSAtPosition(1) ?toggleVis t ?toggleSel t window(2))

Return to top
 ⠀
X