GradientStop
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| index | number | readonly | The index of the GradientStop within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| location | number (range: 0 - 100) | 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 (range: 13 - 87) | 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 | ColorMixedInk | r/w | The swatch (color, gradient, tint, or mixed ink) applied to the gradient stop. Can return: MixedInk or Color. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of GradientStop getElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the GradientStop.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the GradientStop.
Used in:
GradientStop GradientStops.nextItem (obj: GradientStop)
GradientStop GradientStops.previousItem (obj: GradientStop)
Return
Array of GradientStop GradientStop.getElements ()
GradientStop GradientStops.[] (index: number)
GradientStop GradientStops.add ([withProperties: Object])
GradientStop GradientStops.anyItem ()
Array of GradientStop GradientStops.everyItem ()
GradientStop GradientStops.firstItem ()
GradientStop GradientStops.item (index: varies)
Array of GradientStop GradientStops.itemByRange (from: varies, to: varies)
GradientStop GradientStops.lastItem ()
GradientStop GradientStops.middleItem ()
GradientStop GradientStops.nextItem (obj: GradientStop)
GradientStop GradientStops.previousItem (obj: GradientStop)
| Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |