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