GradientStops
GradientStops
Section titled “GradientStops”app.activeDocument.gradients[index].gradientStops
Description
Section titled “Description”A collection of GradientStop objects in a specific gradient. The elements are not named; you must access them by index.
Properties
Section titled “Properties”GradientStops.length
Section titled “GradientStops.length”app.activeDocument.gradients[index].gradientStops.length
Description
Section titled “Description”The number of objects in the collection.
Number; read-only.
GradientStops.parent
Section titled “GradientStops.parent”app.activeDocument.gradients[index].gradientStops.parent
Description
Section titled “Description”The parent of this object.
Object; read-only.
GradientStops.typename
Section titled “GradientStops.typename”app.activeDocument.gradients[index].gradientStops.typename
Description
Section titled “Description”The class name of the referenced object.
String; read-only.
Methods
Section titled “Methods”GradientStops.add()
Section titled “GradientStops.add()”app.activeDocument.gradients[index].gradientStops.add()
Description
Section titled “Description”Creates a new object.
Returns
Section titled “Returns”GradientStops.getByName()
Section titled “GradientStops.getByName()”app.activeDocument.gradients[index].gradientStops.getByName(name)
Description
Section titled “Description”Gets the first element in the collection with the specified name.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
name | String | Name of element to get |
Returns
Section titled “Returns”GradientStops.index()
Section titled “GradientStops.index()”app.activeDocument.gradients[index].gradientStops.index(itemKey)
Description
Section titled “Description”Gets an element from the collection.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
itemKey | String, Number | String or number key |
Returns
Section titled “Returns”GradientStops.removeAll()
Section titled “GradientStops.removeAll()”app.activeDocument.gradients[index].gradientStops.removeAll()
Description
Section titled “Description”Deletes all objects in this collection.
Returns
Section titled “Returns”Nothing.
Example
Section titled “Example”Adding a new gradient stop
Section titled “Adding a new gradient stop”// Adds a new gradient stop to a gradient, color of new stop is 70% grayif (app.documents.length > 0 && app.activeDocument.gradients.length > 0) { // Get a reference to the gradient to change var changeGradient = app.activeDocument.gradients[0];
// Get a reference to the last gradient stop var origCount = changeGradient.gradientStops.length; var lastStop = changeGradient.gradientStops[origCount - 1];
// add the new gradient stop var newStop = changeGradient.gradientStops.add();
// Set the values of the new gradient stop. // Move the original last gradient stop a bit to the left and insert the new gradient stop at the old position newStop.rampPoint = lastStop.rampPoint; lastStop.rampPoint = lastStop.rampPoint - 10;
// Create a new color to apply to the newly created gradient stop var newStopColor = new GrayColor(); newStopColor.gray = 70.0; newStop.color = newStopColor;}