Class LayerComp

Represents a single layer comp in the document.

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/

Example

// Access layer comps
const doc = app.activeDocument;
const layerComp = doc.layerComps[0];
console.log(`Layer comp: ${layerComp.name}`);

Example

// Create and apply a layer comp
const doc = app.activeDocument;
const comp = await doc.layerComps.add("My Design", "A great design", true, true, true);
await comp.apply();

Min Version

24.0

Index

Accessors

appearance childComp comment docId id name parent position selected typename visibility

Methods

apply duplicate recapture remove resetLayerComp

Accessors

appearance

get appearance(): boolean
If true, the layer comp will remember the layers' appearance (layer style) settings.

Returns boolean
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#appearance

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:96
set appearance(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:97

childComp

get childComp(): boolean
If true, the layer comp will remember which of the Smart Object's layer comps are set in the Properties panel.

Returns boolean
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#childcomp

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:120
set childComp(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:121

comment

get comment(): string | null
The description of the layer comp.

Returns string | null
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#comment

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:79
set comment(comment: string | null): void
Parameters
- comment: string | null
Returns void
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:80

docId

get docId(): number
The ID of the document of this layer comp.

Returns number
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#docid

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:57

id

get id(): number
For use with batchPlay operations. This layer comp ID, along with its document ID can be used to represent this layer comp for the lifetime of this document or the layer comp.

Returns number
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#id

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:50

name

get name(): string
The name of the layer comp.

Returns string
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#name

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:71
set name(name: string): void
Parameters
- name: string
Returns void
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:72

parent

get parent(): Document
Owner document of this layer comp

Returns Document
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#parent

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:64

position

get position(): boolean
If true, the layer comp will remember layers' positions.

Returns boolean
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#position

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:104
set position(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:105

selected

get selected(): boolean
If true, the layer comp is currently selected in the Layer Comps panel.

Note: selected does not mean that this layer comp is applied to document.

Returns boolean
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#selected

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:89

typename

get typename(): "LayerComp"
The class name of the referenced LayerComp object

Returns "LayerComp"
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#typename

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:42

visibility

get visibility(): boolean
If true, the layer comp will remember layers' visibilities.

Returns boolean
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#visibility

Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:112
set visibility(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:113

Methods

apply

apply(): Promise<void>
Applies the layer comp to the document.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#apply
Example
```
// Apply the first layer comp
await app.activeDocument.layerComps[0].apply();
```
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:136

duplicate

duplicate(): Promise<LayerComp>
Duplicates this layer comp

Returns Promise<LayerComp>
newly created layer comp
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#duplicate
Example
```
// Duplicate a layer comp
const newComp = await app.activeDocument.layerComps[0].duplicate();
newComp.name = "Copy of " + app.activeDocument.layerComps[0].name;
```
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:218

recapture

recapture(): Promise<void>
Updates the recorded states of the layers for this layer comp.

Applies to all layers and all properties supported by this layer comp.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#recapture
Example
```
// Recapture all properties for all layers
await app.activeDocument.layerComps[0].recapture();
```
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:153
recapture(arg: LayerCompRecaptureOptions, layers?: Layer[]): Promise<void>
Updates the recorded states of the layers for this layer comp.
Parameters
- arg: LayerCompRecaptureOptions
- Optionallayers: Layer[]
  if this argument is passed then only specified layers will be recaptured.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#recapture
Example
```
// Recapture only visibility for specific layers
const layers = [app.activeDocument.layers[0], app.activeDocument.layers[1]];
await app.activeDocument.layerComps[0].recapture({ visibility: true }, layers);
```
Async
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:170

remove

remove(): Promise<void>
Deletes this object from document.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#remove
Example
```
// Delete a layer comp
await app.activeDocument.layerComps[0].remove();
```
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:185

resetLayerComp

resetLayerComp(): Promise<void>
Resets the layer comp state to the document state.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#resetlayercomp
Example
```
// Reset layer comp to current document state
await app.activeDocument.layerComps[0].resetLayerComp();
```
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/LayerComp.d.ts:200

Class LayerComp

See

Example

Example

Min Version

Index

Accessors

Methods

Accessors

appearance

Returns boolean

See

Min Version

Parameters

Returns void

childComp

Returns boolean

See

Min Version

Parameters

Returns void

comment

Returns string | null

See

Min Version

Parameters

Returns void

docId

Returns number

See

Min Version

id

Returns number

See

Min Version

name

Returns string

See

Min Version

Parameters

Returns void

parent

Returns Document

See

Min Version

position

Returns boolean

See

Min Version

Parameters

Returns void

selected

Returns boolean

See

Min Version

typename

Returns "LayerComp"

See

Min Version

visibility

Returns boolean

See

Min Version

Parameters

Returns void

Methods

apply

Returns Promise<void>

See

Example

Async

Min Version

duplicate

Returns Promise<LayerComp>

See

Example

Async

Min Version

recapture

Returns Promise<void>