leCycleSnapPatternDisplay

Product Documentation

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

leCycleSnapPatternDisplay

leCycleSnapPatternDisplay(
[ w_windowId ]
)
=> t_snapPatternDisplayMode

Description

Sets the snap pattern display to the next value in the Snap Pattern Display option, in the order of full, tracks, boundary, and periods.

Arguments

w_windowId

The window ID of the window specified.

Value Returned

t_snapPatternDisplayMode
	Returns the snap pattern display value.

Example

If the Snap Pattern Display option is currently set to full, the snap pattern display value will be cycled as follows:

leCycleSnapPatternDisplay() -> "tracks" 
leCycleSnapPatternDisplay() -> "boundary"
leCycleSnapPatternDisplay() -> "periods"
leCycleSnapPatternDisplay() -> "full"
leCycleSnapPatternDisplay() -> "tracks"

⠀ X