Adobe InDesign CS4 (6.0) Object Model JS: GradientStop

InDesign CS4

Class

GradientStop

 A gradient stop in a gradient.

QuickLinks

getElements, remove, toSource, toSpecifier

Hierarchy

Gradient
GradientStop

Properties

PropertyTypeAccessDescription
indexnumber readonlyThe index of the GradientStop within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
locationnumber (range: 0 - 100) r/wThe starting location (as a percentage of the gradient length) of the gradient stop on the gradient. (Range: 0 to 100).
midpointnumber (range: 13 - 87) r/wThe mid-point (as a percentage of the gradient length) of the gradient stop. (Range: 13 to 87)
parentGradient readonlyThe parent of the GradientStop (a Gradient).
propertiesObject r/wA property that allows setting of several properties at the same time.
stopColorColorMixedInk r/wThe swatch (color, gradient, tint, or mixed ink) applied to the gradient stop. Can return: MixedInk or Color.

Methods

Instances

Array of GradientStop getElements ()
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:

array of GradientStop GradientStops.itemByRange (from: any, to: any)

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: 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)

Jongware, 20-Jun-2010 v3.0.3dContents :: Index