A collection of gradient stops.
Methods
GradientStopadd ([withProperties:
Object])
Creates a new GradientStop.
| Parameter | Type | Description |
|---|---|---|
| withProperties | Object | Initial values for properties of the new GradientStop (Optional) |
GradientStopanyItem ()
Returns any GradientStop in the collection.
number count ()
Displays the number of elements in the GradientStop.
Array of GradientStopeveryItem ()
Returns every GradientStop in the collection.
GradientStopfirstItem ()
Returns the first GradientStop in the collection.
GradientStopitem (index:
any)
Returns the GradientStop with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
GradientStopitemByName (name:
string)
Returns the GradientStop with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of GradientStopitemByRange (from:
any, to:
any)
Returns the GradientStops within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | GradientStop Long Integer String |
The GradientStop, index, or name at the beginning of the range. Can accept: GradientStop, Long Integer or String. |
| to | GradientStop Long Integer String |
The GradientStop, index, or name at the end of the range. Can accept: GradientStop, Long Integer or String. |
GradientStoplastItem ()
Returns the last GradientStop in the collection.
GradientStopmiddleItem ()
Returns the middle GradientStop in the collection.
GradientStopnextItem (obj:
GradientStop)
Returns the GradientStop whose index follows the specified GradientStop in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | GradientStop | The GradientStop whose index comes before the desired GradientStop. |
GradientStoppreviousItem (obj:
GradientStop)
Returns the GradientStop with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | GradientStop | The index of the GradientStop that follows the desired GradientStop. |
string toSource ()
Generates a string which, if executed, will return the GradientStop.
Element of:
Gradient.gradientStops