A color in a gradient.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| index | number | readonly | The index of the GradientStop within its containing object. |
| location | number | r/w | The starting location (as a percentage of the gradient length) of the gradient stop on the gradient. (Range: 0 to 100). |
| midpoint | number | r/w | The mid-point (as a percentage of the gradient length) of the gradient stop. (Range: 13 to 87) |
| parent | Gradient | readonly | The parent of the GradientStop (a Gradient). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| stopColor | any | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gradient stop. Can return: MixedInk or Color. |
Methods
Array of GradientStopgetElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the GradientStop.
string toSource ()
Generates a string which, if executed, will return the GradientStop.
string toSpecifier ()
Retrieves the object specifier.
Used in:
GradientStops.previousItem (
obj:
GradientStop )
GradientStops.nextItem (
obj:
GradientStop )
Returned by:
Array of GradientStop GradientStop .getElements (
)
GradientStop GradientStops.add (
[withProperties:
Object]
)
GradientStop GradientStops.anyItem (
)
Array of GradientStop GradientStops.everyItem (
)
GradientStop GradientStops.firstItem (
)
GradientStop GradientStops.item (
index:
any
)
GradientStop GradientStops.itemByName (
name:
string
)
Array of GradientStop GradientStops.itemByRange (
from:
any, to:
any
)
GradientStop GradientStops.lastItem (
)
GradientStop GradientStops.middleItem (
)
GradientStop GradientStops.nextItem (
obj:
GradientStop
)
GradientStop GradientStops.previousItem (
obj:
GradientStop
)