GradientStops

A collection of gradient stops.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

GradientStop [] (index:Number)

Returns the GradientStop with the specified index.

Parameter	Type	Description
index	Number	The index.

GradientStop add (withProperties:Object)

Creates a new GradientStop.

Parameter	Type	Description
withProperties	Object	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 LongInteger String)

Returns the GradientStop with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

GradientStop itemByRange (from:Varies GradientStop LongInteger String, to:Varies GradientStop LongInteger String)

Returns the GradientStops within the specified range.

Parameter	Type	Description
from	GradientStop LongInteger String	The GradientStop, index, or name at the beginning of the range. Can accept: GradientStop, Long Integer or String.
to	GradientStop LongInteger String	The GradientStop, index, or name at the end of the range. Can accept: GradientStop, Long Integer or String.

Parameter

Type

Description

from

GradientStop

LongInteger

String

The GradientStop, index, or name at the beginning of the range. Can accept: GradientStop, Long Integer or String.

GradientStop

LongInteger

String

The GradientStop, index, or name at the end of the range. Can accept: GradientStop, Long Integer 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	GradientStop	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	GradientStop	The index of the GradientStop that follows the desired GradientStop.

String toSource ()

Generates a string which, if executed, will return the GradientStop.

Object of

Gradient.gradientStops