Gradients¶
app.activeDocument.gradients
Description¶
A collection of Gradient objects in a document.
Properties¶
Gradients.length¶
app.activeDocument.gradients.length
Description¶
The number of objects in the collection.
Type¶
Number; read-only.
Gradients.parent¶
app.activeDocument.gradients.parent
Description¶
The parent of this object.
Type¶
Object; read-only.
Gradients.typename¶
app.activeDocument.gradients.typename
Description¶
The class name of the referenced object.
Type¶
String; read-only.
Methods¶
Gradients.add()¶
app.activeDocument.gradients.add()
Description¶
Creates a new Gradient object.
Returns¶
Gradients.getByName()¶
app.activeDocument.gradients.getByName(name)
Description¶
Gets the first element in the collection with the specified name.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
name |
String | Name of element to get |
Returns¶
Gradients.index()¶
app.activeDocument.gradients.index(itemKey)
Description¶
Gets an element from the collection.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
itemKey |
String, Number | String or number key |
Returns¶
Gradients.removeAll()¶
app.activeDocument.gradients.removeAll()
Description¶
Deletes all elements in this collection.
Returns¶
Nothing.
Example¶
Removing a gradient¶
// Deletes the first gradient from the current document
if (app.documents.length > 0) {
app.activeDocument.gradients[0].remove();
}