groupLayer

Represents a group layer

Layer
↳ GroupLayer

Constructors

constructor

+ new GroupLayer(id: number, docId: number): GroupLayer

Overrides void

Parameters:

Name	Type
`id`	number
`docId`	number

Properties

isGroupLayer

• isGroupLayer: boolean

Accessors

bounds

• get bounds(): PsCommon.Bounds

Inherited from [Layer]/ps_reference/classes/layer/).bounds

Bounds of the layer, including the effects

const { left, top, right, bottom } = layer.bounds
Copied to your clipboard
const { left, top, right, bottom } = layer.bounds

boundsNoEffects

• get boundsNoEffects(): PsCommon.Bounds

Inherited from Layer.boundsNoEffects

Bounds of the layer excluding effects

const { left, top, right, bottom } = layer.boundsNoEffects
Copied to your clipboard
const { left, top, right, bottom } = layer.boundsNoEffects

children

• get children(): LayerTypes[]

The child layers of this group layer

group.children.forEach((child) => {
  ...
})
Copied to your clipboard
1group.children.forEach((child) => {
2  ...
3})

kind

• get kind(): LayerKind

Inherited from Layer.kind

Kind of the layer

if (layer.kind === LayerKind.TEXT) {
  ...
}
Copied to your clipboard
1if (layer.kind === LayerKind.TEXT) {
2  ...
3}

linkedLayers

• get linkedLayers(): Layer[]

Inherited from Layer.linkedLayers

Layers linked to this layer

const layers = layerAA.linkedLayers
layers.forEach((layer) => {
  ...
})
Copied to your clipboard
1const layers = layerAA.linkedLayers
2layers.forEach((layer) => {
3  ...
4})

parent

• get parent(): GroupLayer | null

Inherited from Layer.parent

The group layer this layer is in, null if layer has no parent

Methods

delete

▸ delete(): void

Inherited from Layer.delete

Deletes this layer from the document.

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

number of layer elements deleted

duplicate

▸ duplicate(targetDocument?: Document, name?: string): Promise‹Layer›

Inherited from Layer.duplicate

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

async

Parameters:

Name	Type	Description
`targetDocument?`	Document	if specified, duplicate to a different document target.
`name?`	string	-

flip

▸ flip(axis: "horizontal" | "vertical" | "both"): Promise‹void›

Inherited from Layer.flip

Flips the layer on one or both axis.

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

async

Parameters:

Name	Type	Description
`axis`	"horizontal" \| "vertical" \| "both"	Which axis (or both) to flip the layer on. - "horizontal": flip layer on horizontal axis - "vertical": flip layer on vertical axis - "both": flip layer on both axes

link

▸ link(targetLayer: Layer): Layer[]

Inherited from Layer.link

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"
Copied 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:

Name	Type	Description
`targetLayer`	Layer	layer to link with

array of linked layers

moveAbove

▸ moveAbove(target?: LayerTypes): void

Inherited from Layer.moveAbove

Moves the layer to a position above the target layer or group. If no target layer is defined, move this layer up one slot.

foregroundLayer.moveAbove(backingLayer)
// foregroundLayer
// backingLayer
Copied to your clipboard
1foregroundLayer.moveAbove(backingLayer)
2// foregroundLayer
3// backingLayer

Parameters:

Name	Type	Description
`target?`	LayerTypes	layer or group that will proceed this layer.

moveBelow

▸ moveBelow(target?: LayerTypes): void

Inherited from Layer.moveBelow

Moves the layer to a position below the target layer or group. If no target layer is defined, move this layer down one slot.

backingLayer.moveBelow(foregroundLayer)
// foregroundLayer
// backingLayer
Copied to your clipboard
1backingLayer.moveBelow(foregroundLayer)
2// foregroundLayer
3// backingLayer

Parameters:

Name	Type	Description
`target?`	LayerTypes	layer or group that will preceed this layer.

nudge

▸ nudge(horizontal: number | PercentValue | PixelValue, vertical: number | PercentValue | PixelValue): Promise‹void›

Inherited from Layer.nudge

Moves the layer.

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

// move the layer one height down
let percent = (v) => ({ _unit: "percentUnit", _value: v })
await layer.nudge(percent(0), percent(100))
Copied to your clipboard
1// nudge the layer to the left by 200px
2await layer.nudge(-200, 0)
3
4// move the layer one height down
5let percent = (v) => ({ _unit: "percentUnit", _value: v })
6await layer.nudge(percent(0), percent(100))

async

Parameters:

Name	Type	Description
`horizontal`	number \| PercentValue \| PixelValue	Numeric value to offset layer by in pixels or percent
`vertical`	number \| PercentValue \| PixelValue	Numeric value to offset layer by in pixels or percent

rotate

▸ rotate(angle: number | AngleValue, options?: object): Promise‹void›

Inherited from Layer.rotate

Rotates the layer.

// rotate 90 deg counter clockwise
await layer.rotate(-90)
Copied to your clipboard
1// rotate 90 deg counter clockwise
2await layer.rotate(-90)

async

Parameters:

▪ angle: number | AngleValue

Angle to rotate the layer by in degrees

▪Optional options: object

Name	Type	Description
`interpolation?`	InterpolationMethod	Interpolation method to use when resampling the image @default InterpolationMethod.bilinear

scale

▸ scale(width: number | PercentValue, height: number | PercentValue, options?: object): Promise‹void›

Inherited from Layer.scale

Scales the layer.

await layer.scale(80, 80)
Copied to your clipboard
await layer.scale(80, 80)

async

Parameters:

▪ width: number | PercentValue

Numeric percentage to scale layer horizontally

▪ height: number | PercentValue

Numeric percentage to scale layer vertically

▪Optional options: object

Name	Type	Description
`interpolation?`	InterpolationMethod	Interpolation method to use when resampling the image @default InterpolationMethod.bilinear

skew

▸ skew(angleH: number | AngleValue, angleV: number | AngleValue, options?: object): Promise‹void›

Inherited from Layer.skew

Applies a skew to the layer.

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

async

Parameters:

▪ angleH: number | AngleValue

Horizontal angle to skew by

▪ angleV: number | AngleValue

Vertical angle to skew by

▪Optional options: object

Name	Type
`interpolation?`	InterpolationMethod

unlink

▸ unlink(): Promise‹void›

Inherited from Layer.unlink

Unlinks the layer from any existing links.

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

async

Getting Started

Last updated 9/29/2021

Was this helpful?

Yes

groupLayer

Constructors.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

constructor.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Properties

isGroupLayer

Accessors

bounds

boundsNoEffects

children

kind

linkedLayers

parent

Methods

delete

duplicate

flip

link

moveAbove

moveBelow

nudge

rotate

scale

skew

unlink

Constructors

constructor