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();

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();

Properties

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

Methods

add

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

<br/> Promise<LayerComp>

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.

Parameters

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);

getAllByName

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

<br/> LayerComp[]

Get all Layer Comps by name

Parameters

Name
Type
name
string

removeAll

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">24.0</span>

<br/> Promise<void>

Clears all Layer Comps from this collection