Gradient
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| gradientStops | GradientStops | readonly | A collection of gradient stops. |
| id | number | readonly | The unique ID of the Gradient. |
| index | number | readonly | The index of the Gradient within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the Gradient. |
| parent | ApplicationDocument | readonly | The parent of the Gradient (a Application or Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| type | GradientType: GradientType.LINEAR GradientType.RADIAL |
r/w | The gradient type. |
Methods
Instances
Gradient duplicate ()
Duplicates the Gradient.
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of Gradient getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
Swatch merge (with:
any)
Merges the specified swatches with the swatch.
| Parameter | Type | Description |
|---|---|---|
| with | Array of Swatches String Swatch | The swatches to merge. Can accept: Array of Swatches, Swatch or String. |
void remove ([replacingWith:
Swatch])
Deletes the swatch.
| Parameter | Type | Description |
|---|---|---|
| replacingWith | Swatch | The swatch to apply in place of the deleted swatch. (Optional) |
string toSource ()
Generates a string which, if executed, will return the Gradient.
string toSpecifier ()
Retrieves the object specifier.
Element of
GradientStop.parent
Used in:
array of Gradient Gradients.itemByRange (from: any, to: any)
Gradient Gradients.nextItem (obj: Gradient)
Gradient Gradients.previousItem (obj: Gradient)
Return
Gradient Gradient.duplicate ()
Array of Gradient Gradient.getElements ()
Gradient Gradients.[] (index: number)
Gradient Gradients.add ([withProperties: Object])
Gradient Gradients.anyItem ()
Array of Gradient Gradients.everyItem ()
Gradient Gradients.firstItem ()
Gradient Gradients.item (index: any)
Gradient Gradients.itemByID (id: number)
Gradient Gradients.itemByName (name: string)
Array of Gradient Gradients.itemByRange (from: any, to: any)
Gradient Gradients.lastItem ()
Gradient Gradients.middleItem ()
Gradient Gradients.nextItem (obj: Gradient)
Gradient Gradients.previousItem (obj: Gradient)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |