Layer

An object within a document that contains visual elements of the image, equivalent to a layer in Photoshop.

You can access layers in a document using Document.layers collection.

If the object is representing a group layer, you can access it's children layers using Layer.layers property.

Properties#

Methods#

bringToFront#

void

Moves the layer to a position above the topmost layer or group.

clear#

async : Promise<void>

Clears the layer pixels and does not copy to the clipboard. If no pixel selection is found, select all pixels and clear.

copy#

async : Promise<void>

Copies the layer to the clipboard. When the optional argument is set to true, a merged copy is performed (that is, all visible layers are copied to the clipboard).

await layer.copy(true)
await layer.copy()
CopyCopied to your clipboard
1await layer.copy(true)
2await layer.copy()

Parameters#

cut#

async : Promise<void>

Cuts the layer to the clipboard. If no selection is found then select all the pixels and then cut.

delete#

void

Deletes this layer from the document.

const layers = document.layers
layers && layers[0] && layers[0].delete()
CopyCopied to your clipboard
1const layers = document.layers
2layers && layers[0] && layers[0].delete()

duplicate#

async : Promise<Layer>

Duplicates the layer, creating a copy above it in layer stack, and returns the newly created layer.

// duplicate a layer
const copyLayer = await layer.duplicate()

// extract to a new document
const exportDoc = psApp.documents[1]
const exportedLayer = await layer.duplicate(exportDoc)
CopyCopied to your clipboard
1// duplicate a layer
2const copyLayer = await layer.duplicate()
3
4// extract to a new document
5const exportDoc = psApp.documents[1]
6const exportedLayer = await layer.duplicate(exportDoc)

Parameters#

flip#

async : Promise<void>

Flips the layer on one or both axis.

// flip horizontally
await layer.flip.horizontal()
CopyCopied to your clipboard
1// flip horizontally
2await layer.flip.horizontal()

Parameters#

link#

Layer[]

Creates a link between this layer and the target layer if not already linked, and returns a list of layers linked to this layer.

// link two layers together
const linkedLayers = strokes.link(fillLayer)
linkedLayers.forEach((layer) => console.log(layer.name))
> "strokes"
> "fillLayer"
CopyCopied to your clipboard
1// link two layers together
2const linkedLayers = strokes.link(fillLayer)
3linkedLayers.forEach((layer) => console.log(layer.name))
4> "strokes"
5> "fillLayer"

Parameters#

merge#

async : Promise<Layer>

Merges layers. This operates on the currently selected layers. If multiple layers are selected, they will be merged together. If one layer is selected, it is merged down with the layer beneath. In this case, the layer below must be a pixel layer. The merged layer will now be the active layer.

move#

void

Moves the layer relative to the layer specified in parameters. "placeAfter" places the layer below relativeObject. "placeBefore" places the layer above relativeObject. "placeInside" places the layer inside relativeObject if relativeObject is a group layer. ElementPlacement.PLACEINSIDE is only valid when relativeObject.kind === LayerKind.group

Parameters#

rasterize#

async : Promise<void>

Converts the targeted contents in the layer into a flat, raster image.

Parameters#

rotate#

async : Promise<void>

Rotates the layer.

// rotate 90 deg counter clockwise
await layer.rotate(-90)

// rotate 90 deg clockwise relative to top left corner
let anchorPos = require('photoshop').constants.AnchorPosition
await layer.rotate(90, anchorPos.TOPLEFT)
CopyCopied to your clipboard
1// rotate 90 deg counter clockwise
2await layer.rotate(-90)
3
4// rotate 90 deg clockwise relative to top left corner
5let anchorPos = require('photoshop').constants.AnchorPosition
6await layer.rotate(90, anchorPos.TOPLEFT)

Parameters#

scale#

async : Promise<void>

Scales the layer. Renamed from resize in ExtendScript.

await layer.scale(80, 80)

// Scale the layer to be a quarter of the size relative to bottom left corner
let anchorPos = require('photoshop').constants.AnchorPosition
await layer.scale(50, 50, anchorPos.BOTTOMLEFT)
CopyCopied to your clipboard
1await layer.scale(80, 80)
2
3// Scale the layer to be a quarter of the size relative to bottom left corner
4let anchorPos = require('photoshop').constants.AnchorPosition
5await layer.scale(50, 50, anchorPos.BOTTOMLEFT)

Parameters#

sendToBack#

void

Moves the layer to the bottom. If the bottom layer is the background, it will move the layer to the position above the background. If it is in a group, it will move to the bottom of the group.

skew#

async : Promise<void>

Applies a skew to the layer.

// parellelogram shape
await layer.skew(-15, 0)
CopyCopied to your clipboard
1// parellelogram shape
2await layer.skew(-15, 0)

Parameters#

translate#

async : Promise<void>

Moves the layer (translation).

// Translate the layer to the left by 200px
await layer.translate(-200, 0)

// move the layer one height down
let xOffsetPct = {_unit: "percentUnit", _value: 0};
let yOffsetPct = {_unit: "percentUnit", _value: 100};
await layer.translate(xOffsetPct, yOffsetPct);
CopyCopied to your clipboard
1// Translate the layer to the left by 200px
2await layer.translate(-200, 0)
3
4// move the layer one height down
5let xOffsetPct = {_unit: "percentUnit", _value: 0};
6let yOffsetPct = {_unit: "percentUnit", _value: 100};
7await layer.translate(xOffsetPct, yOffsetPct);

Parameters#

unlink#

async : Promise<void>

Unlinks the layer from any existing links.

// detach layer from any existing links
await layer.unlink()
CopyCopied to your clipboard
1// detach layer from any existing links
2await layer.unlink()

Last updated 2/8/2022

Was this helpful?

Yes

No