ColorTrapPresets

A collection of trap presets.

Instance Properties

Name	Description	Access
length	number The number of objects in the collection.	read-only

Methods

[withProperties])

)

)

→ number

)

)

index)

id)

name)

from, to)

)

)

obj)

obj)

)

→ string

add( [withProperties]) → TrapPreset

Creates a new TrapPreset.

withProperties Object Initial values for properties of the new TrapPreset (Optional)

anyItem( ) → TrapPreset

Returns any TrapPreset in the collection.

count( ) → number

Displays the number of elements in the TrapPreset.

everyItem( ) → TrapPreset

Returns every TrapPreset in the collection.

firstItem( ) → TrapPreset

Returns the first TrapPreset in the collection.

item( index) → TrapPreset

Returns the TrapPreset with the specified index or name.

index The index or name. Can accept: Long Integer or String.

itemByID( id) → TrapPreset

Returns the TrapPreset with the specified ID.

`id`	number The ID.

itemByName( name) → TrapPreset

Returns the TrapPreset with the specified name.

name string The name.

itemByRange( from, to) → TrapPreset

Returns the TrapPresets within the specified range.

`from`	The TrapPreset, index, or name at the beginning of the range. Can accept: TrapPreset, Long Integer or String.
`to`	The TrapPreset, index, or name at the end of the range. Can accept: TrapPreset, Long Integer or String.

lastItem( ) → TrapPreset

Returns the last TrapPreset in the collection.

middleItem( ) → TrapPreset

Returns the middle TrapPreset in the collection.

nextItem( obj) → TrapPreset

Returns the TrapPreset whose index follows the specified TrapPreset in the collection.

obj TrapPreset The TrapPreset whose index comes before the desired TrapPreset.

previousItem( obj) → TrapPreset

Returns the TrapPreset with the index previous to the specified index.

obj TrapPreset The index of the TrapPreset that follows the desired TrapPreset.

toSource( ) → string

Generates a string which, if executed, will return the TrapPreset.