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

tpaSetFilterByNumber

tpaSetFilterByNumber(
x_filterNumber 
)
=> t / nil

Description

Sets the Track Pattern Assistant Filter field using the list order number for the desired setting.

Arguments

x_filterNumber

Sets the Track Pattern Assistant Filter field to the entry in the list order that is represented by this number. If the number is the same as the current Filter setting, no action is taken in order to prevent the other filter fields from being overwritten.

Valid values: 0 through n, where n is the number of entries in the Filter list. A value of 0 resets all the Track Pattern Assistant filters and clears the V (Visibility) column of the Track Pattern table.

Value Returned

t

Track Pattern Assistant Filter field is set to the given value. The Track Pattern table is refreshed using the new filter.

nil

Track Pattern Assistant Filter field not set because the number was invalid or was the same as the current filter setting.

Examples

Resets all the Track Pattern Assistant filters and clears the V (Visibility) column of the Track Pattern table:

tpaSetFilterByNumber(0)

Resets all the Track Pattern Assistant filters:

tpaSetFilterByNumber(1)

Sets the Track Pattern Filter to the second entry in the list:

tpaSetFilterByNumber(2)

Return to top
 ⠀
X