Adobe InDesign CS3 (5.0) Object Model JS: Gradient

InDesign CS3

Class

Gradient

 A gradient. Base Class: Swatch

QuickLinks

duplicate, extractLabel, getElements, insertLabel, merge, remove, toSource, toSpecifier

Hierarchy

Application | Document
Swatch
Gradient
GradientStop

Properties

PropertyTypeAccessDescription
gradientStopsGradientStops readonlyA collection of gradient stops.
idnumber readonlyThe unique ID of the Gradient.
indexnumber readonlyThe index of the Gradient within its containing object.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the Gradient.
parentApplicationDocument readonlyThe parent of the Gradient (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
typeGradientType:
GradientType.LINEAR
GradientType.RADIAL
r/wThe gradient type.

Methods

Instances

Gradient duplicate ()
Duplicates the Gradient.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Gradient getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Swatch merge (with: any)
Merges the specified swatches with the swatch.

ParameterTypeDescription
with Array of Swatches
String
Swatch
The swatches to merge. Can accept: Array of Swatches, Swatch or String.

void remove ([replacingWith: Swatch])
Deletes the swatch.

ParameterTypeDescription
replacingWithSwatchThe swatch to apply in place of the deleted swatch. (Optional)

string toSource ()
Generates a string which, if executed, will return the Gradient.

string toSpecifier ()
Retrieves the object specifier.

Element of

GradientStop.parent

Used in:

array of Gradient Gradients.itemByRange (from: any, to: any)

Gradient Gradients.nextItem (obj: Gradient)

Gradient Gradients.previousItem (obj: Gradient)

Return

Gradient Gradient.duplicate ()

Array of Gradient Gradient.getElements ()

Gradient Gradients.add ([withProperties: Object])

Gradient Gradients.anyItem ()

Array of Gradient Gradients.everyItem ()

Gradient Gradients.firstItem ()

Gradient Gradients.item (index: any)

Gradient Gradients.itemByID (id: number)

Gradient Gradients.itemByName (name: string)

Array of Gradient Gradients.itemByRange (from: any, to: any)

Gradient Gradients.lastItem ()

Gradient Gradients.middleItem ()

Gradient Gradients.nextItem (obj: Gradient)

Gradient Gradients.previousItem (obj: Gradient)

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