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

pteSetNoneLayerSetMember

pteSetNoneLayerSetMember(
[ ?mode { Display | Selection | Propagate } ]
[ ?only { t | nil } ]
[ ?panel { Layers | Objects | Grids } ]
[ ?window w_windowId ]
)
=> t / nil

Description

Removes from the active layer set all items that meet the specified criteria.

Arguments

?mode

Scope of execution of the command.

Valid values:

  • Display: Items displayed in the specified Palette panel are removed from the active layer set. If the parent and child items in the Objects and Grids panels are in a desynchronized state, only the parent objects or grids are removed from the active layer set.
  • Selection: The items that are selected in the specified Palette panel are removed from the active layer set.
    The Selection option is applicable when multi-select mode is selected in Palette Options form or it is enabled using the environment variable, pteMultiSelectionMode. This lets you select multiple LPPs in the Layers panel using the CTRL + LMB or Shift + LMB after an initial LMB click on an LPP. The Selection mode in the active command applies to the selected LPPs Layers panel.
  • Propagate: Both parent and child items are removed from the active layer set. Use this mode only if the parent and child items in the Objects and Grids panels are in the desynchronized state.

?only

If set to t, only the items corresponding to the specified mode are removed from the layer set.

?panel

Name of the Palette panel.
Valid values: Layers, Objects, and Grids
Default: The panel that is currently active. If none of the panels is active, the command is run on the Layers panel.

?window 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-purpose pairs were removed from the active layer set.

nil

The command was unsuccessful.

Examples

pteSetNoneLayerSetMember(?panel "Layers")
pteSetNoneLayerSetMember(?only t)
pteSetNoneLayerSetMember(?mode "Display")
pteSetNoneLayerSetMember(?window window(2))
pteSetNoneLayerSetMember(?mode "Display" ?only t ?panel "Layers" ?window window(2))

Return to top
 ⠀
X