LayerComps

A collections class allowing for array access into a document's Layer Comps

Access this collection through Document.layerComps property. For example, following adds a new Layer Comp to the collection:

const comp = await app.activeDocument.layerComps.add();
Copied to your clipboard
const comp = await app.activeDocument.layerComps.add();

Indexable

▪ [index: number]: LayerComp

Used to access the Layer Comp in the collection

Access this collection through Document.layerComps property. For example, following adds a new Layer Comp to the collection:

const comp = await app.activeDocument.layerComps.add();
Copied to your clipboard
const comp = await app.activeDocument.layerComps.add();

Name	Type	Access	Min Version	Description
length	number	R	24.0	Number of LayerComp elements in this collection
parent	Document	R	24.0	The owner document of this Layer comp collection
typename	string	R	24.0	The name for this object collection: LayerComps

24.0

Adds a Layer Comp to the document's collection. If no options are given, only visibility will be recorded.

Note: This command will fail if the document is flat, that is, only a Background and no other layers.

Name	Type	Default value	Description
`options`	LayerCompCreateOptions	{}	An optional object literal containing key/value pairs as described by LayerCompCreateOptions `javascript const options = { name: "mockup", comment: "First attempt", visibility: true, position: true }; await require('photoshop').app.activeDocument.layerComps.add(options);`

24.0

Get all Layer Comps by name

Name	Type
`name`	string

24.0

Promise<void>

Clears all Layer Comps from this collection

Was this helpful?