Gradients
A collection of gradients.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
Gradient [] (index:Number)
Returns the Gradient with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Gradient add (withProperties:Object)
Creates a new Gradient.
|
Parameter |
Type |
Description |
|---|---|---|
|
withProperties |
Initial values for properties of the new Gradient (Optional) |
Gradient anyItem ()
Returns any Gradient in the collection.
Number count ()
Displays the number of elements in the Gradient.
Gradient everyItem ()
Returns every Gradient in the collection.
Gradient firstItem ()
Returns the first Gradient in the collection.
Gradient item (index:Varies LongInteger String)
Returns the Gradient with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
Gradient itemByID (id:Number)
Returns the Gradient with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Gradient itemByName (name:String)
Returns the Gradient with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Gradient itemByRange (from:Varies Gradient LongInteger String, to:Varies Gradient LongInteger String)
Returns the Gradients within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The Gradient, index, or name at the beginning of the range. Can accept: Gradient, Long Integer or String. |
|
to |
LongInteger |
The Gradient, index, or name at the end of the range. Can accept: Gradient, Long Integer or String. |
Gradient lastItem ()
Returns the last Gradient in the collection.
Gradient middleItem ()
Returns the middle Gradient in the collection.
Gradient nextItem (obj:Gradient)
Returns the Gradient whose index follows the specified Gradient in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Gradient whose index comes before the desired Gradient. |
Gradient previousItem (obj:Gradient)
Returns the Gradient with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Gradient that follows the desired Gradient. |
String toSource ()
Generates a string which, if executed, will return the Gradient.
Object of
Application.gradients
Document.gradients