Adobe InDesign CS (3.0) Object Model JS: Gradient

Class

Gradient

A gradient. Base Class: Swatch

Gradient

Property	Type	Access	Description
gradientStops	GradientStops	readonly	A collection of gradient stops.
id	number	readonly	The unique ID of the Gradient.
index	number	readonly	The index of the Gradient within its containing object.
label	string	r/w	A property that can be set to any string.
name	string	r/w	The name of the Gradient.
parent	Application Document	readonly	The parent of the Gradient (a Application or Document).
properties	Object	r/w	A property that allows setting of several properties at the same time.
type	GradientType: GradientType.LINEAR GradientType.RADIAL	r/w	The gradient type.

Gradient duplicate ()
Duplicates the Gradient.

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

Parameter	Type	Description
key	string	The key.

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

Parameter	Type	Description
key	string	The key.
value	string	The value.

void merge (with: any)
Merge one or more other swatches into this one.

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

void remove (replacingWith: Swatch)
Delete swatch.

Parameter	Type	Description
replacingWith	Swatch	The swatch to apply in place of this one

Gradient Gradient.duplicate ()

Gradient Gradients.add ([withProperties: Object])

Jongware, 27-Jun-2010 v3.0.3d