Gradients
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Gradient add ([withProperties:
Object])
Creates a new Gradient.
| Parameter | Type | Description |
|---|---|---|
| withProperties | Object | 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.
Array
of Gradient everyItem ()
Returns every Gradient in the collection.
Gradient firstItem ()
Returns the first Gradient in the collection.
Gradient item (index:
any)
Returns the Gradient with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | 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 | number | The ID. |
Gradient itemByName (name:
string)
Returns the Gradient with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of Gradient itemByRange (from:
any, to:
any)
Returns the Gradients within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Gradient Long Integer String | The Gradient, index, or name at the beginning of the range. Can accept: Gradient, Long Integer or String. |
| to | Gradient Long Integer String | 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 | Gradient | 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 | Gradient | The index of the Gradient that follows the desired Gradient. |
string toSource ()
Generates a string which, if executed, will return the Gradient.
Element of
Application.gradients
Document.gradients
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |