FlattenerPresets

A collection of transparency flattener presets.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

FlattenerPreset [] (index:Number)

Returns the FlattenerPreset with the specified index.

Parameter

Type

Description

index

Number

The index.

FlattenerPreset add (withProperties:Object)

Creates a new FlattenerPreset.

Parameter

Type

Description

withProperties

Object

Initial values for properties of the new FlattenerPreset (Optional)

FlattenerPreset anyItem ()

Returns any FlattenerPreset in the collection.

Number count ()

Displays the number of elements in the FlattenerPreset.

FlattenerPreset everyItem ()

Returns every FlattenerPreset in the collection.

FlattenerPreset firstItem ()

Returns the first FlattenerPreset in the collection.

FlattenerPreset item (index:Varies LongInteger String)

Returns the FlattenerPreset with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

FlattenerPreset itemByID (id:Number)

Returns the FlattenerPreset with the specified ID.

Parameter

Type

Description

id

Number

The ID.

FlattenerPreset itemByName (name:String)

Returns the FlattenerPreset with the specified name.

Parameter

Type

Description

name

String

The name.

FlattenerPreset itemByRange (from:Varies FlattenerPreset LongInteger String, to:Varies FlattenerPreset LongInteger String)

Returns the FlattenerPresets within the specified range.

Parameter

Type

Description

from

FlattenerPreset

LongInteger

String

The FlattenerPreset, index, or name at the beginning of the range. Can accept: FlattenerPreset, Long Integer or String.

to

FlattenerPreset

LongInteger

String

The FlattenerPreset, index, or name at the end of the range. Can accept: FlattenerPreset, Long Integer or String.

FlattenerPreset lastItem ()

Returns the last FlattenerPreset in the collection.

FlattenerPreset middleItem ()

Returns the middle FlattenerPreset in the collection.

FlattenerPreset nextItem (obj:FlattenerPreset)

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

Parameter

Type

Description

obj

FlattenerPreset

The FlattenerPreset whose index comes before the desired FlattenerPreset.

FlattenerPreset previousItem (obj:FlattenerPreset)

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

Parameter

Type

Description

obj

FlattenerPreset

The index of the FlattenerPreset that follows the desired FlattenerPreset.

String toSource ()

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

Object of

Application.flattenerPresets