LayerComp
Represents a single layer comp in the document.
Properties
| Name | Type | Access | Min Version | Description |
|---|---|---|---|---|
appearance | boolean | R W | 24.0 | If true, the layer comp will remember the layers' appearance (layer style) settings. |
childComp | boolean | R W | 24.0 | If true, the layer comp will remember which of the Smart Object's layer comps are set in the Properties panel. |
comment | string | R W | 24.0 | The description of the layer comp. |
docId | number | R | 24.0 | The ID of the document of this layer comp. |
id | number | R | 24.0 | 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. |
name | string | R W | 24.0 | The name of the layer comp. |
parent | R | 24.0 | Owner document of this layer comp | |
position | boolean | R W | 24.0 | If true, the layer comp will remember layers' positions. |
selected | boolean | R | 24.0 | 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. |
typename | string | R | 24.0 | The class name of the referenced LayerComp object |
visibility | boolean | R W | 24.0 | If true, the layer comp will remember layers' visibilities. |
Methods
apply
24.0async : Promise<void>
Applies the layer comp to the document.
duplicate
24.0async : Promise<LayerComp>
Duplicates this layer comp
recapture
24.0async : 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.
async : Promise<void>
Updates the recorded states of the layers for this layer comp.
Parameters
| Name | Type | Description |
|---|---|---|
arg | - | |
layers? | Layer[] | if this argument is passed then only specified layers will be recaptured. |
remove
24.0async : Promise<void>
Deletes this object from document.
resetLayerComp
24.0async : Promise<void>
Resets the layer comp state to the document state.