Class 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.

See

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

Example

group.layers.forEach((layer) => {
  layer.visible = true;
})

Index

Accessors

allLocked

get allLocked(): boolean
When set to true, prevents edits to pixels and properties of this layer.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:66
set allLocked(locking: boolean): void
Parameters
- locking: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:67

blendMode

get blendMode(): BlendMode
The blend mode of the layer.

Fixes in Photoshop 24.2:
- Now it will throw error when passing non-existent blend mode
- Also will throw error if combination of document color mode, bit depth and blend mode is not possible instead of failing silently
- Prior this version it was possible to set blend mode for background layer which turned it into regular layer as a side effect and also changed its ID. Not it will throw error instead since these side effects are not expected to happen
Returns BlendMode
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#blendmode

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:214
set blendMode(blendMode: BlendMode): void
Parameters
- blendMode: BlendMode
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:215

fillOpacity

get fillOpacity(): number
The fill opacity of the layer, in percentage.

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

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:142
set fillOpacity(opacity: number): void
Parameters
- opacity: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:143

filterMaskDensity

get filterMaskDensity(): number
The density of the filter mask, in percentage.

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

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:150
set filterMaskDensity(density: number): void
Parameters
- density: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:151

filterMaskFeather

get filterMaskFeather(): number
The feather of the filter mask between 0.0 and 1000.0.

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

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:158
set filterMaskFeather(feather: number): void
Parameters
- feather: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:159

id

get id(): number
ID of the layer, can be used for making batchPlay calls.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:241

isBackgroundLayer

get isBackgroundLayer(): boolean
True when the layer is the special Background layer.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:98

isClippingMask

get isClippingMask(): boolean
Whether the layer is being used as a clipping mask. Releasing a clipping mask will also release the layers above.

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

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:198
set isClippingMask(clipped: boolean): void
Parameters
- clipped: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:199

kind

get kind(): LayerKind
The kind of the layer.

Returns LayerKind
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#kind

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:113

layerMaskDensity

get layerMaskDensity(): number
The density of the layer mask, in percentage.

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

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:166
set layerMaskDensity(density: number): void
Parameters
- density: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:167

layerMaskFeather

get layerMaskFeather(): number
The feather of the layer mask between 0.0 and 1000.0.

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

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:174
set layerMaskFeather(feather: number): void
Parameters
- feather: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:175

layers

get layers(): Layers | null
The layers inside this group layer.

Returns Layers | null
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:1072

linkedLayers

get linkedLayers(): Layers
Layers linked to this layer. See Layer.link

Returns Layers
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#linkedlayers

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:222

locked

get locked(): boolean
True if any property of this layer is locked.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:59

name

get name(): string
Name of the layer.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:229

opacity

get opacity(): number
The master opacity of the layer, in percent.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:134
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:135

parent

get parent(): Layer | null
The group layer that contains this layer. It will return null if the layer is a top layer in the document.

Returns Layer | null
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#parent

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:256

pixelsLocked

get pixelsLocked(): boolean
When set to true, prevents the pixels of this layer from being edited.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:74
set pixelsLocked(locking: boolean): void
Parameters
- locking: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:75

positionLocked

get positionLocked(): boolean
When set to true, prevents the layer from being moved.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:82
set positionLocked(locking: boolean): void
Parameters
- locking: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:83

selected

set selected(select: boolean): void
Parameters
- select: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:263

textItem

get textItem(): TextItem
The object that contains properties and methods related to Text for Layers whose kind is equal to LayerKind.TEXT

Returns TextItem
Min Version
24.2
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:269

transparentPixelsLocked

get transparentPixelsLocked(): boolean
When set to true, prevents the transparent pixels from being edited.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:90
set transparentPixelsLocked(locking: boolean): void
Parameters
- locking: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:91

typename

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

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

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:52

vectorMaskDensity

get vectorMaskDensity(): number
The density of the vector mask, in percentage.

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

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:182
set vectorMaskDensity(density: number): void
Parameters
- density: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:183

vectorMaskFeather

get vectorMaskFeather(): number
The feather of the vector mask between 0.0 and 1000.0.

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

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:190
set vectorMaskFeather(feather: number): void
Parameters
- feather: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:191

visible

get visible(): boolean
True when the layer is visible.

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

Min Version
22.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:105
set visible(visible: boolean): void
Parameters
- visible: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:106

Methods

applyAddNoise

applyAddNoise(
    amount: number,
    distribution: NoiseDistribution,
    monochromatic: boolean,
): Promise<void>
Applies the Add Noise filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- amount: number
  Percentage of noise applied [0.1,400].
- distribution: NoiseDistribution
  Distribution method to use.
- monochromatic: boolean
  Adds black and white noise if true.
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:295

applyAverage

applyAverage(): Promise<void>
Applies the Average filter.

Unsupported color modes: Indexed Color, Bitmap

Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:304

applyBlur

applyBlur(): Promise<void>
Applies the Blur filter.

Unsupported color modes: Indexed Color, Bitmap

Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:313

applyBlurMore

applyBlurMore(): Promise<void>
Applies the Blur More filter.

Unsupported color modes: Indexed Color, Bitmap

Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:322

applyClouds

applyClouds(): Promise<void>
Applies the Clouds filter.

Unsupported color modes: Indexed Color, Bitmap

Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:331

applyCustomFilter

applyCustomFilter(
    characteristics: number[],
    scale: number,
    offset: number,
): Promise<void>
Applies the Custom filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- characteristics: number[]
  Square matrix (5 x 5) used to perform filter operation.
- scale: number
  The value by which to divide the sum of the pixel values included in the calculation
- offset: number
  The value to be added to the result of the scale calculation.
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:343

applyDeInterlace

applyDeInterlace(
eliminateFields: EliminateFields,
createFields: CreateFields,
): Promise<void>
Applies the De-Interlace filter.

Unsupported color modes: Indexed Color, Bitmap, CMYK 8 bits, CMYK 16 bits, Duotone 8 bits
Parameters
- eliminateFields: EliminateFields
  Eliminate EVENFIELDS or ODDFIELDS field order.
- createFields: CreateFields
  Create fields by either DUPLICATION or INTERPOLATION.
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:354

applyDespeckle

applyDespeckle(): Promise<void>
Applies the Despeckle filter.

Unsupported color modes: Indexed Color, Bitmap, RGB 32 bits, Grayscale 32 bits

Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:363

applyDifferenceClouds

applyDifferenceClouds(): Promise<void>
Applies the Difference Clouds filter.

Unsupported color modes: Indexed Color, Bitmap, Lab 8 bits, Lab 16 bits

Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:372

applyDiffuseGlow

applyDiffuseGlow(
    graininess: number,
    glowAmount: number,
    clearAmount: number,
): Promise<void>
Applies the Diffuse Glow filter.

Supported color modes: RGB 8 bits, Duotone 8 bits, Grayscale 8 bits, Multichannel 8 bits
Parameters
- graininess: number
  The amount of grain [0,10].
- glowAmount: number
  The glow amount [0,20].
- clearAmount: number
  The clear amount [0,20].
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:384

applyDisplace

applyDisplace(
    horizontalScale: number,
    verticalScale: number,
    displacementType: DisplacementMapType,
    undefinedAreas: UndefinedAreas,
    displacementMapFile: File,
): Promise<void>
Applies the Displace filter using the specified horizontal and vertical scale, mapping type, treatment of undistorted areas, and path to the distortion image map.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- horizontalScale: number
  How much to scale in the direction of width [-999,999].
- verticalScale: number
  How much to scale in the direction of height [-999,999].
- displacementType: DisplacementMapType
  Describes how the displacement map fits the image if the image is not the same size as the map.
- undefinedAreas: UndefinedAreas
  The method used to treat undistorted areas or areas left blank in an image to which the filter in the Distor category has been applied.
- displacementMapFile: File
  Path to the distortion image map.
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:403

applyDustAndScratches

applyDustAndScratches(radius: number, threshold: number): Promise<void>
Applies the Dust & Scratches filter.

Unsupported color modes: Indexed Color, Bitmap, RGB 32 bits, Grayscale 32 bits
Parameters
- radius: number
  The radius of the filter in pixels [1,100].
- threshold: number
  The lower the amount, the stronger the effect [0,255].
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:420

applyGaussianBlur

applyGaussianBlur(radius: number): Promise<void>
Applies the Gaussian Blur filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- radius: number
  The radius of the filter in pixels [0.1,250].
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:430

applyGlassEffect

applyGlassEffect(
    distortion: number,
    smoothness: number,
    scaling: number,
    invert?: boolean,
    texture?: TextureType,
    textureFile?: File,
): Promise<void>
Applies the Glass filter.

Supported color modes: RGB 8 bits, Duotone 8 bits, Grayscale 8 bits, Multichannel 8 bits
Parameters
- distortion: number
  Change the amount the glass distorts the image [0,20].
- smoothness: number
  Change the smoothness of the glass [1,15].
- scaling: number
  The percentage value to scale by [50,200].
- Optionalinvert: boolean
  Invert the glass (default: false).
- Optionaltexture: TextureType
  The type of glass texture. This argument is ignored if "textureFile" is provided. (default: TextureType.CANVAS)
- OptionaltextureFile: File
  Mapping for glass distortion (optional).
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:446

applyHighPass

applyHighPass(radius: number): Promise<void>
Applies the High Pass filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- radius: number
  The width of high pass filter (pixels) [0.1,1000].
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:463

applyImage

applyImage(applyImageOptions: ApplyImageOptions): Promise<void>
The applyImage method lets you blend one image’s layer and channel (the source) with a this layer (the target). This will change pixels contained in this layer. Performs Image > Apply Image on the document. See the ApplyImageOptions object for more info and examples.
Parameters
- applyImageOptions: ApplyImageOptions
  Option object for applyImage.
Returns Promise<void>
Async
Min Version
24.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:774

applyLensBlur

applyLensBlur(
    source?: DepthMapSource,
    focalDistance?: number,
    invertDepthMask?: boolean,
    shape?: Geometry,
    radius?: number,
    bladeCurvature?: number,
    rotation?: number,
    brightness?: number,
    threshold?: number,
    amount?: number,
    distribution?: NoiseDistribution,
    monochromatic?: boolean,
): Promise<void>
Applies the Lens Blur filter.

Unsupported color modes: Indexed Color, Bitmap, RGB 32 bits, Grayscale 32 bits
Parameters
- Optionalsource: DepthMapSource
  The source for the depth map (default: DepthMapSource.NONE)
- OptionalfocalDistance: number
  The blur focal distance for the depth map [0,255] (default: 0).
- OptionalinvertDepthMask: boolean
  True if the depth map is inverted (default: false)
- Optionalshape: Geometry
  The shape of the iris (default: Geometry.HEXAGON)
- Optionalradius: number
  The radius of the iris [0,100] (default: 15)
- OptionalbladeCurvature: number
  The blade curvature of the iris [0,100] (default: 0)
- Optionalrotation: number
  The rotation of the iris [0,360] (default: 0)
- Optionalbrightness: number
  The brightness for the specular highlights [0,100] (default: 0)
- Optionalthreshold: number
  The threshold for the specular highlights [0,255] (default: 0)
- Optionalamount: number
  The amount of noise [0,100] (default: 0)
- Optionaldistribution: NoiseDistribution
  The distribution value for the noise (default: NoiseDistribution.UNIFORM)
- Optionalmonochromatic: boolean
  True if the noise is monochromatic (default: false)
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:484

applyLensFlare

applyLensFlare(
    brightness: number,
    flareCenter: { x: number; y: number },
    lensType?: LensType,
): Promise<void>
Applies the Lens Flare filter.

Supported color modes: RGB 8 bits, RGB 16 bits, RGB 32 bits
Parameters
- brightness: number
  Percentage of brightness applied [10,300].
- flareCenter: { x: number; y: number }
  The flare center {x: number, y: number}.
  - x: number
    The horizontal coordinate in pixels.
  - y: number
    The vertical coordinate in pixels.
- OptionallensType: LensType
  The lens type used to produce the effect (default: LensType.ZOOMLENS).
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:511

applyMaximum

applyMaximum(radius: number, preserveShape?: PreserveShape): Promise<void>
Applies the Maximum filter

Unsupported color modes: Indexed Color, Bitmap
Parameters
- radius: number
  The radius of the filter in pixels.
  Integer in the range [1,500] when using SQUARENESS.
  Float in the range [0.2,500] when using ROUNDNESS.
- OptionalpreserveShape: PreserveShape
  Favor hard corners or smooth curves around the edges
  (default: PreserveShape.SQUARENESS)
Returns Promise<void>
Min Version
23.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:527

applyMedianNoise

applyMedianNoise(radius: number): Promise<void>
Applies the Median filter

Unsupported color modes: Indexed Color, Bitmap, RGB 32 bits, Grayscale 32 bits
Parameters
- radius: number
  The radius of the filter in pixels [1,500]
Returns Promise<void>
Min Version
23.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:549

applyMinimum

applyMinimum(radius: number, preserveShape?: PreserveShape): Promise<void>
Applies the Minimum filter

Unsupported color modes: Indexed Color, Bitmap
Parameters
- radius: number
  The radius of the filter in pixels.
  Integer in the range [1,500] when using SQUARENESS.
  Float in the range [0.2,500] when using ROUNDNESS.
- OptionalpreserveShape: PreserveShape
  Favor hard corners or smooth curves around the edges
  (default: PreserveShape.SQUARENESS)
Returns Promise<void>
Min Version
23.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:540

applyMotionBlur

applyMotionBlur(angle: number, distance: number): Promise<void>
Applies the Motion Blur filter

Unsupported color modes: Indexed Color, Bitmap
Parameters
- angle: number
  The angle the blur effect will be applied at (degrees) [-360,360]
- distance: number
  The amount of blur [1,2000]
Returns Promise<void>
Min Version
23.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:559

applyNTSC

applyNTSC(): Promise<void>
Applies the NTSC Colors filter

Supported color modes: RGB 8 bits, RGB 16 bits, RGB 32 bits

Returns Promise<void>
Min Version
23.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:567

applyOceanRipple

applyOceanRipple(size: number, magnitude: number): Promise<void>
Applies the Ocean Ripple filter

Supported color modes: RGB 8 bits, Duotone 8 bits, Grayscale 8 bits, Multichannel 8 bits
Parameters
- size: number
  The Ripple size [1,15]
- magnitude: number
  The Ripple magnitude [1,20]
Returns Promise<void>
Min Version
23.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:577

applyOffset

applyOffset(
    horizontal: number,
    vertical: number,
    undefinedAreas?: OffsetUndefinedAreas,
): Promise<void>
Applies the Offset filter

Unsupported color modes: Indexed Color, Bitmap
Parameters
- horizontal: number
  The horizontal offset [-2 * doc.width, 2 * doc.width]
- vertical: number
  The vertical offset [-2 * doc.height, 2 * doc.height]
- OptionalundefinedAreas: OffsetUndefinedAreas
  Method to use to fill the empty space left by the offset
  (default: OffsetUndefinedAreas.WRAPAROUND).
Returns Promise<void>
Min Version
23.5
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:589

applyPinch

applyPinch(amount: number): Promise<void>
Applies the Pinch filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- amount: number
  The pinch amount. Negative value creates effect of expansion and positive creates effect of contraction. [-100,100]
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:610

applyPolarCoordinates

applyPolarCoordinates(conversion: PolarConversionType): Promise<void>
Applies the Polar Coordinates filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- conversion: PolarConversionType
  The conversion type.
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:620

applyRipple

applyRipple(amount: number, size: RippleSize): Promise<void>
Applies the Ripple filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- amount: number
  The ripple amount. [-999,999]
- size: RippleSize
  The ripple size.
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:631

applySharpen

applySharpen(): Promise<void>
Applies the Sharpen filter.

Unsupported color modes: Indexed Color, Bitmap

Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:640

applySharpenEdges

applySharpenEdges(): Promise<void>
Applies the Sharpen Edges filter.

Unsupported color modes: Indexed Color, Bitmap, RGB 32 bits, Grayscale 32 bits

Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:649

applySharpenMore

applySharpenMore(): Promise<void>
Applies the Sharpen More filter.

Unsupported color modes: Indexed Color, Bitmap

Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:658

applyShear

applyShear(
curve: { x: number; y: number }[],
undefinedArea: UndefinedAreas,
): Promise<void>
Applies the the Shear filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- curve: { x: number; y: number }[]
  Specification of the shear curve in points as coordinates object with x, y properties e.g.in the format [{x:-20, y:1}, {x:30, y:128}]. Any number higher than 2 of coordinate objects can be specified. For "x" coordinate it is recommended to use range [-63,64] and for "y" coordinate use range [1,128]. For bests results please make sure that first point has 0 at "y" axis and last point has 128 at "y" axis. Also sort points by "y" value in ascending order. Follow these rules to ensure that curve will be shown correctly in dialog UI.
- undefinedArea: UndefinedAreas
  The treatment of areas left blank by the distortion.
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:674

applySmartBlur

applySmartBlur(
    radius: number,
    threshold: number,
    blurQuality: SmartBlurQuality,
    mode: SmartBlurMode,
): Promise<void>
Applies the Smart Blur filter.

Supported color modes: RGB 8 bits, CMYK 8 bits, Duotone 8 bits,

Grayscale 8 bits, Lab 8 bits, Multichannel 8 bits
Parameters
- radius: number
  The blur radius [0.1,100].
- threshold: number
  The blur threshold [0.1,100].
- blurQuality: SmartBlurQuality
  The smoothness or graininess of the blurred image.
- mode: SmartBlurMode
  The smart blur mode.
Returns Promise<void>
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:694

applySpherize

applySpherize(amount: number, mode: SpherizeMode): Promise<void>
Applies the Spherize filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- amount: number
  The amount of distortion [-100,100].
- mode: SpherizeMode
  The distortion mode.
Returns Promise<void>
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:710

applyTwirl

applyTwirl(angle: number): Promise<void>
Applies the Twirl filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- angle: number
  The amount of twirl to apply (degrees) [-999,999]
Returns Promise<void>
Min Version
23.5

Async
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:599

applyUnSharpMask

applyUnSharpMask(
    amount: number,
    radius: number,
    threshold: number,
): Promise<void>
Applies the Unsharp Mask filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- amount: number
  The amount of sharpening (as a whole number percentage) [1,500].
- radius: number
  The radius in pixels [0.1,1000].
- threshold: number
  The contrast threshold [0,255].
Returns Promise<void>
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:722

applyWave

applyWave(
    generatorNumber: number,
    minimumWavelength: number,
    maximumWavelength: number,
    minimumAmplitude: number,
    maximumAmplitude: number,
    horizontalScale: number,
    verticalScale: number,
    waveType?: WaveType,
    undefinedAreas?: UndefinedAreas,
    randomSeed?: number,
): Promise<void>
Applies the Wave filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- generatorNumber: number
  The whole number of generators [1,999].
- minimumWavelength: number
  The minimum wave length [1,(maximum wave length - 1)] (whole number).
- maximumWavelength: number
  The maximum wave length [(minimum wave length + 1),999] (whole number).
- minimumAmplitude: number
  The minimum amplitude [1,(maximum amplitude - 1)] (whole number).
- maximumAmplitude: number
  The maximum amplitude [(minimum amplitude + 1),999] (whole number).
- horizontalScale: number
  The amount of horizontal scale (as a percentage) [1,100] (whole number).
- verticalScale: number
  The amount of vertical scale (as a percentage) [1,100] (whole number).
- OptionalwaveType: WaveType
  The wave type (optional).
- OptionalundefinedAreas: UndefinedAreas
  The treatment of areas left blank by the distortion (optional).
- OptionalrandomSeed: number
  The random seed (optional).
Returns Promise<void>
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:741

applyZigZag

applyZigZag(amount: number, ridges: number, style: ZigZagType): Promise<void>
Applies the ZigZag filter.

Unsupported color modes: Indexed Color, Bitmap
Parameters
- amount: number
  The amount of zigzag [-100,100].
- ridges: number
  The number of ridges [0,20].
- style: ZigZagType
  The zigzag style.
Returns Promise<void>
Async
Min Version
24.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:764

bringToFront

bringToFront(): void
Moves the layer to a position above the topmost layer or group.

Returns void
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#bringtofront

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:877

clear

clear(): Promise<void>
Clears the layer pixels and does not copy to the clipboard. If no pixel selection is found, select all pixels and clear.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#clear

Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:1021

copy

copy(merge?: boolean): 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).
Parameters
- Optionalmerge: boolean
  Whether to perform a merged copy.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#copy
Example
```
await layer.copy(true)
await layer.copy()
```
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:1039

cut

cut(): Promise<void>
Cuts the layer contents to the clipboard. If no selection is found then select all the pixels and then cut.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#cut

Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:1048

delete

delete(): void
Deletes this layer from the document.

Returns void
Number of layer elements deleted.
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#delete
Example
```
const layers = document.layers
layers && layers[0] && layers[0].delete()
```
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:790

duplicate

duplicate(
    relativeObject?: Document | Layer,
    insertionLocation?: ElementPlacement,
    name?: string,
): Promise<Layer | null>
Duplicates the layer, creating a copy above it in layer stack, and returns the newly created layer.
Parameters
- OptionalrelativeObject: Document | Layer
  If specified, duplicate to a different document or relative to another layer.
- OptionalinsertionLocation: ElementPlacement
  Where to insert the duplicated layer.
- Optionalname: string
  Name for the duplicated layer.
Returns Promise<Layer | null>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#duplicate
Example
```
// duplicate a layer
const copyLayer = await layer.duplicate()
```
Example
```
// extract to a new document
const exportDoc = psApp.documents[1]
const exportedLayer = await layer.duplicate(exportDoc)
```
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:817

flip

flip(axis: FlipAxis): Promise<void>
Flips the layer on one or both axis.
Parameters
- axis: FlipAxis
  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
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#flip
Example
```
// flip horizontally
await layer.flip('horizontal');
```
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:935

link

link(targetLayer: Layer): 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.
Parameters
- targetLayer: Layer
  The layer to link to.
Returns Layer[]
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#link
Example
```
// link two layers together
const linkedLayers = strokes.link(fillLayer)
linkedLayers.forEach((layer) => console.log(layer.name))
// "strokes"
// "fillLayer"
```
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:841

merge

merge(): 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.

Returns Promise<Layer>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#merge

Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:1060

move

move(relativeObject: Layer, insertLocation: ElementPlacement): 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
- relativeObject: Layer
  The layer to move relative to.
- insertLocation: ElementPlacement
  Where to place the layer.
Returns void
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#move

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:870

rasterize

rasterize(target: RasterizeType): Promise<void>
Converts the targeted contents in the layer into a flat, raster image.
Parameters
- target: RasterizeType
Returns Promise<void>
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:1067

rotate

rotate(
    angle: number | AngleValue,
    anchor?: AnchorPosition,
    options?: { interpolation?: InterpolationMethod },
): Promise<void>
Rotates the layer.
Parameters
- angle: number | AngleValue
  Angle to rotate the layer by in degrees.
- Optionalanchor: AnchorPosition
  Anchor position to rotate around.
- Optionaloptions: { interpolation?: InterpolationMethod }
  - Optionalinterpolation?: InterpolationMethod
    Interpolation method to use when resampling the image.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#rotate
Example
```
// 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)
```
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:988

scale

scale(
    width: number | PercentValue,
    height: number | PercentValue,
    anchor?: AnchorPosition,
    options?: { interpolation?: InterpolationMethod },
): Promise<void>
Scales the layer.

Renamed from resize in ExtendScript.
Parameters
- width: number | PercentValue
  Numeric percentage to scale layer horizontally.
- height: number | PercentValue
  Numeric percentage to scale layer vertically.
- Optionalanchor: AnchorPosition
  Anchor position to rotate around.
- Optionaloptions: { interpolation?: InterpolationMethod }
  - Optionalinterpolation?: InterpolationMethod
    Interpolation method to use when resampling the image.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#scale
Example
```
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)
```
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:959

sendToBack

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.

Returns void
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#sendtoback

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:886

skew

skew(
    angleH: number | AngleValue,
    angleV: number | AngleValue,
    options?: { interpolation?: InterpolationMethod },
): Promise<void>
Applies a skew to the layer.
Parameters
- angleH: number | AngleValue
  Horizontal angle to skew by.
- angleV: number | AngleValue
  Vertical angle to skew by.
- Optionaloptions: { interpolation?: InterpolationMethod }
  - Optionalinterpolation?: InterpolationMethod
    Interpolation method to use when resampling the image.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#skew
Example
```
// parallelogram shape
await layer.skew(-15, 0)
```
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:1009

translate

translate(
horizontal: number | PercentValue | PixelValue,
vertical: number | PercentValue | PixelValue,
): Promise<void>
Moves the layer (translation).
Parameters
- 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.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#translate
Example
```
// Translate the layer to the left by 200px
await layer.translate(-200, 0)
```
Example
```
// move the layer one height down
let xOffsetPct = {_unit: "percentUnit", _value: 0};
let yOffsetPct = {_unit: "percentUnit", _value: 100};
await layer.translate(xOffsetPct, yOffsetPct);
```
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:912

unlink

unlink(): Promise<void>
Unlinks the layer from any existing links.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layer/#unlink
Example
```
// detach layer from any existing links
await layer.unlink()
```
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Layer.d.ts:856

Class Layer

See

Example

Index

Accessors

Methods

Accessors

allLocked

Returns boolean

See

Min Version

Parameters

Returns void

blendMode

Returns BlendMode

See

Min Version

Parameters

Returns void

bounds

Returns ImagingBounds

See

Min Version

boundsNoEffects

Returns ImagingBounds

See

Min Version

document

Returns Document

See

Min Version

fillOpacity

Returns number

See

Min Version

Parameters

Returns void

filterMaskDensity

Returns number

See

Min Version

Parameters

Returns void

filterMaskFeather

Returns number

See

Min Version

Parameters

Returns void

id

Returns number

See

Min Version

isBackgroundLayer

Returns boolean

See

Min Version

isClippingMask

Returns boolean

See

Min Version

Parameters

Returns void

kind

Returns LayerKind

See

Min Version

layerMaskDensity

Returns number

See

Min Version

Parameters

Returns void

layerMaskFeather

Returns number

See

Min Version

Parameters

Returns void

layers