ColorGradientStops

A collection of gradient stops.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[withProperties])
 → GradientStop
count(
)
 → number
item(
index)
 → GradientStop
itemByRange(
from, to)
 → GradientStop
nextItem(
obj)
 → GradientStop
toSource(
)
 → string
add(
[withProperties])
 → GradientStop
Creates a new GradientStop.
withProperties Object Initial values for properties of the new GradientStop (Optional)
anyItem(
)
 → GradientStop
Returns any GradientStop in the collection.
count(
)
 → number
Displays the number of elements in the GradientStop.
everyItem(
)
 → GradientStop
Returns every GradientStop in the collection.
firstItem(
)
 → GradientStop
Returns the first GradientStop in the collection.
item(
index)
 → GradientStop
Returns the GradientStop with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
 → GradientStop
Returns the GradientStops within the specified range.
from The GradientStop, index, or name at the beginning of the range. Can accept: GradientStop, Long Integer or String.
to The GradientStop, index, or name at the end of the range. Can accept: GradientStop, Long Integer or String.
lastItem(
)
 → GradientStop
Returns the last GradientStop in the collection.
middleItem(
)
 → GradientStop
Returns the middle GradientStop in the collection.
nextItem(
obj)
 → GradientStop
Returns the GradientStop whose index follows the specified GradientStop in the collection.
obj GradientStop The GradientStop whose index comes before the desired GradientStop.
previousItem(
obj)
 → GradientStop
Returns the GradientStop with the index previous to the specified index.
obj GradientStop The index of the GradientStop that follows the desired GradientStop.
toSource(
)
 → string
Generates a string which, if executed, will return the GradientStop.