ArtLayer

An object within a document that contains the visual elements of the image (equivalent to a layer in the Adobe Photoshop application).

Go to Property Listing | Method Listing

Methods:

add, applyStyle, applyStyleFile, saveStyleFile, clear, copy, cut, merge, rasterize, applyAverage, applyGaussianBlur, applyLensBlur, applyBlur, applyBlurMore, applyMotionBlur, applyRadialBlur, applySmartBlur, applyDiffuseGlow, applyDisplace, applyGlassEffect, applyOceanRipple, applyPinch, applyPolarCoordinates, applyRipple, applyShear, applySpherize, applyTwirl, applyWave, applyZigZag, applyAddNoise, applyDespeckle, applyDustAndScratches, applyMedianNoise, applyClouds, applyDifferenceClouds, applyLensFlare, applyTextureFill, applySharpen, applySharpenEdges, applySharpenMore, applyUnSharpMask, applyDeInterlace, applyNTSC, applyCustomFilter, applyHighPass, applyMaximum, applyMinimum, applyOffset, adjustLevels, autoLevels, autoContrast, adjustCurves, adjustBrightnessContrast, adjustColorBalance, desaturate, selectiveColor, mixChannels, invert, equalize, threshold, posterize, photoFilter, shadowHighlight

Objects:

Boolean, LayerKind, Number, String, TextItem

Hierarchy:

Superclass: Layer

Class: ArtLayer

Property Listing

Property	Type	Access	Description
fillOpacity	Number	read/write	The interior opacity of the layer. Range: 0.0 to 100.0.
filterMaskDensity	Number	read/write	The density of the filter mask (between 0.0 and 100.0)
filterMaskFeather	Number	read/write	The feather of the filter mask (between 0.0 and 250.0)
grouped	Boolean	read/write	If true, the layer is grouped with the layer below.
isBackgroundLayer	Boolean	read/write	If true, the layer is a background layer.
kind	LayerKind LayerKind.NORMAL LayerKind.TEXT LayerKind.SOLIDFILL LayerKind.GRADIENTFILL LayerKind.PATTERNFILL LayerKind.LEVELS LayerKind.CURVES LayerKind.COLORBALANCE LayerKind.BRIGHTNESSCONTRAST LayerKind.HUESATURATION LayerKind.SELECTIVECOLOR LayerKind.CHANNELMIXER LayerKind.GRADIENTMAP LayerKind.INVERSION LayerKind.THRESHOLD LayerKind.POSTERIZE LayerKind.SMARTOBJECT LayerKind.PHOTOFILTER LayerKind.EXPOSURE LayerKind.LAYER3D LayerKind.VIDEO LayerKind.BLACKANDWHITE LayerKind.VIBRANCE LayerKind.COLORLOOKUP	read/write	Sets the layer kind (such as 'text layer') for an empty layer. Valid only when the layer is empty and when 'is background layer ' is false. You can use the 'kind ' property to make a background layer a normal layer; however, to make a layer a background layer, you must set 'is background layer' to true.
layerMaskDensity	Number	read/write	The density of the layer mask (between 0.0 and 100.0)
layerMaskFeather	Number	read/write	The feather of the layer mask (between 0.0 and 250.0)
parent		readonly	The object's container.
pixelsLocked	Boolean	read/write	If true, the pixels in the layer's image cannot be edited.
positionLocked	Boolean	read/write	If true, the pixels in the layer's image cannot be moved within the layer.
textItem	TextItem	readonly	The text that is associated with the layer. Valid only when 'kind' is text layer.
transparentPixelsLocked	Boolean	read/write	If true, editing is confined to the opaque portions of the layer.
typename	String	readonly	The class name of the object.
vectorMaskDensity	Number	read/write	The density of the vector mask (between 0.0 and 100.0)
vectorMaskFeather	Number	read/write	The feather of the vector mask (between 0.0 and 250.0)

Method Listing

ArtLayer add ()

Adds an element.

undefined adjustBrightnessContrast (brightness:Int, contrast:Int)

Adjusts the brightness and constrast.

Parameter	Type	Description
brightness	Int	The brightness amount. Range: -100 to 100.
contrast	Int	The contrast amount. Range: -100 to 100.

undefined adjustColorBalance ([shadows:Array of Int], [midtones:Array of Int], [highlights:Array of Int], [preserveLuminosity:Boolean])

Adjusts the color balance of the layer's component channels.

Parameter	Type	Description
shadows	Array of Int	The adjustments for the shadows. The array must include three values (in the range -100 to 100), which represent cyan or red, magenta or green, and yellow or blue, when the document mode is CMYK or RGB.
midtones	Array of Int	The adjustments for the midtones. The array must include three values (in the range -100 to 100), which represent cyan or red, magenta or green, and yellow or blue, when the document mode is CMYK or RGB.
highlights	Array of Int	The adjustments for the highlights. The array must include three values (in the range -100 to 100), which represent cyan or red, magenta or green, and yellow or blue, when the document mode is CMYK or RGB.
preserveLuminosity	Boolean	If true, luminosity is preserved.

undefined adjustCurves (curveShape:Array of Point)

Adjusts the tonal range of the selected channel using up to fourteen points.

Parameter	Type	Description
curveShape	Array of Point	The curve points. The number of points must be between 2 and 14.

undefined adjustLevels (inputRangeStart:Int, inputRangeEnd:Int, inputRangeGamma:Number, outputRangeStart:Int, outputRangeEnd:Int)

Adjusts levels of the selected channels.

Parameter	Type	Description
inputRangeStart	Int (range 0 - 253)	The input levels minimum. Range: 0 to 253.
inputRangeEnd	Int	The input levels maximum. Range: (input range start + 2) to 253.
inputRangeGamma	Number	The input levels gamma. Range: 0.10 to 9.99.
outputRangeStart	Int (range 0 - 253)	The output levels minimum. Range: 0 to 253.
outputRangeEnd	Int	The output levels maximum. Range: (output range start + 2) to 253.

undefined applyAddNoise (amount:Number, distribution:NoiseDistribution, monochromatic:Boolean)

Applies the add noise filter.

Parameter	Type	Description
amount	Number	The amount of noise (as a percentage). Range: 0.1 to 400.0.
distribution	NoiseDistribution NoiseDistribution.UNIFORM NoiseDistribution.GAUSSIAN	The noise distribution type.
monochromatic	Boolean	If true, applies the filter only to the tonal elements in the image without changing the colors.

Parameter

Type

Description

amount

Number

The amount of noise (as a percentage). Range: 0.1 to 400.0.

distribution

NoiseDistribution

NoiseDistribution.UNIFORM

NoiseDistribution.GAUSSIAN

The noise distribution type.

monochromatic

Boolean

If true, applies the filter only to the tonal elements in the image without changing the colors.

undefined applyAverage ()

Applies the average filter.

undefined applyBlur ()

Applies the blur filter.

undefined applyBlurMore ()

Applies the blur more filter.

undefined applyClouds ()

Applies the clouds filter.

undefined applyCustomFilter (characteristics:Array of Int, scale:Int, offset:Int)

Applies the custom filter.

Parameter	Type	Description
characteristics	Array of Int	The custom filter characteristics. This is an array of 25 values that corresponds to a left-to-right, top-to- bottom traversal of the array presented in the Custom dialog in the user interface (Filter > Other > Custom).
scale	Int	The value by which to divide the sum of the brightness values of the pixels included in the calculation.
offset	Int	The value to be added to the result of the scale calculation.

undefined applyDeInterlace (eliminateFields:EliminateFields, createFields:CreateFields)

Applies the de-interlace filter.

Parameter	Type	Description
eliminateFields	EliminateFields EliminateFields.ODDFIELDS EliminateFields.EVENFIELDS	The fields to eliminate.
createFields	CreateFields CreateFields.DUPLICATION CreateFields.INTERPOLATION	The method to use to replace eliminated fields.

Parameter

Type

Description

eliminateFields

EliminateFields

EliminateFields.ODDFIELDS

EliminateFields.EVENFIELDS

The fields to eliminate.

createFields

CreateFields

CreateFields.DUPLICATION

CreateFields.INTERPOLATION

The method to use to replace eliminated fields.

undefined applyDespeckle ()

Applies the despeckle filter.

undefined applyDifferenceClouds ()

Applies the difference clouds filter.

undefined applyDiffuseGlow (graininess:Int, glowAmount:Int, clearAmount:Int)

Applies the diffuse glow filter.

Parameter	Type	Description
graininess	Int (range 0 - 10)	The amount of graininess. Range: 0 to 10.
glowAmount	Int (range 0 - 20)	The glow amount. Range: 0 to 20.
clearAmount	Int (range 0 - 20)	The clear amount. Range: 0 to 20.

undefined applyDisplace (horizontalScale:Int, verticalScale:Int, displacementType:DisplacementMapType, undefinedAreas:UndefinedAreas, displacementMapFile:File)

Applies the displace filter.

Parameter	Type	Description
horizontalScale	Int	The amount of horizontal distortion. Range: -999 to 999.
verticalScale	Int	The amount of vertical distortion. Range: -999 to 999.
displacementType	DisplacementMapType DisplacementMapType.STRETCHTOFIT DisplacementMapType.TILE	The displacement type.
undefinedAreas	UndefinedAreas UndefinedAreas.WRAPAROUND UndefinedAreas.REPEATEDGEPIXELS	The treatment of undistorted areas.
displacementMapFile	File	The distortion image map.

undefined applyDustAndScratches (radius:Int, threshold:Int)

Applies the dust and scratches filter.

Parameter	Type	Description
radius	Int (range 1 - 16)	The size (in pixels) of the area searched for dissimilar pixels. Range: 1 to 16.
threshold	Int (range 0 - 255)	Determines how dissimilar the pixels should be before they are eliminated. Range: 0 to 255.

undefined applyGaussianBlur (radius:Number)

Applies the gaussian blur filter.

Parameter	Type	Description
radius	Number	The blur width in pixels. Range: 1.0 to 250.0.

undefined applyGlassEffect (distortion:Int, smoothness:Int, scaling:Int, [invert:Boolean=Boolean], [texture:TextureType], [textureFile:File])

Applies the glass filter.

Parameter	Type	Description
distortion	Int (range 0 - 20)	The amount of distortion. Range: 0 to 20.
smoothness	Int (range 1 - 15)	The smoothness. Range: 1 to 15.
scaling	Int (range 50 - 200)	The amount of scaling. Range: 50 to 200.
invert	Boolean	If true, the texture is inverted. (default: false)
texture	TextureType TextureType.BLOCKS TextureType.CANVAS TextureType.FROSTED TextureType.TINYLENS TextureType.FILE	The type of texture.
textureFile	File	The file from which to load the texture type.

undefined applyHighPass (radius:Number)

Applies the high pass filter.

Parameter	Type	Description
radius	Number	The width (in pixels) of the radius where edge details are retained.

undefined applyLensBlur ([source:DepthMapSource=DepthMapSource], [focalDistance:Int=Int], [invertDepthMap:Boolean=Boolean], [shape:Geometry=Geometry], [radius:Int=Int], [bladeCurvature:Int=Int], [rotation:Int=Int], [brightness:Int=Int], [threshold:Int=Int], [amount:Int=Int], [distribution:NoiseDistribution=NoiseDistribution], [monochromatic:Boolean=Boolean])

Apply the lens blur filter.

Parameter	Type	Description
source	DepthMapSource DepthMapSource.NONE DepthMapSource.TRANSPARENCYCHANNEL DepthMapSource.LAYERMASK DepthMapSource.IMAGEHIGHLIGHT	The source for the depth map. (default: DepthMapSource.NONE)
focalDistance	Int	The blur focal distance (in pixels) for the depth map. RangeL 0 to 255. Valid only when 'source' is transparency or layer mask. (default: 0)
invertDepthMap	Boolean	If true, inverts the depth map. (default: false)
shape	Geometry Geometry.TRIANGLE Geometry.PENTAGON Geometry.HEXAGON Geometry.SQUARE Geometry.HEPTAGON Geometry.OCTAGON	The shape of the iris. (default: Geometry.HEXAGON)
radius	Int (range 0 - 100)	The radius of the iris. Range: 0 to 100. (default: 15)
bladeCurvature	Int (range 0 - 100)	The blade curvature of the iris. Range: 0 to 100. (default: 0)
rotation	Int (range 0 - 360)	The rotation of the iris (in degrees). Range: 0 to 360. (default: 0)
brightness	Int (range 0 - 100)	The brightness for the specular highlights. Range: 0 to 100. (default: 0)
threshold	Int (range 0 - 255)	The threshold for the specular highlights. Range: 0 to 255. (default: 0)
amount	Int (range 0 - 100)	The amount of noise. Range: 0 to 100. (default: 0)
distribution	NoiseDistribution NoiseDistribution.UNIFORM NoiseDistribution.GAUSSIAN	The distribution value for the noise. (default: NoiseDistribution.UNIFORM)
monochromatic	Boolean	If true, the noise is monochromatic. (default: false)

undefined applyLensFlare (brightness:Int, flareCenter:UnitPoint, lensType:LensType)

Applies the lens flare filter.

Parameter	Type	Description
brightness	Int (range 10 - 300)	The flare brightness. Range: 10 to 300.
flareCenter	UnitPoint	The position of the flare center.
lensType	LensType LensType.ZOOMLENS LensType.PRIME35 LensType.PRIME105 LensType.MOVIEPRIME	The lens type.

Parameter

Type

Description

brightness

Int (range 10 - 300)

The flare brightness. Range: 10 to 300.

flareCenter

UnitPoint

The position of the flare center.

lensType

LensType

LensType.ZOOMLENS

LensType.PRIME35

LensType.PRIME105

LensType.MOVIEPRIME

The lens type.

undefined applyMaximum (radius:Number)

Applies the maximum filter.

Parameter	Type	Description
radius	Number (range 0 - 100)	The choke area (in pixels). Range: 0 to 100.

undefined applyMedianNoise (radius:Number)

Applies the median noise filter.

Parameter	Type	Description
radius	Number (range 0 - 100)	The size of the area searched for pixels of similar brightness. Range: 0 to 100.

undefined applyMinimum (radius:Number)

Applies the minimum filter.

Parameter	Type	Description
radius	Number (range 0 - 100)	The spread area (in pixels). Range: 0 to 100.

undefined applyMotionBlur (angle:Int, radius:Number)

Applies the motion blur filter.

Parameter	Type	Description
angle	Int	The angle (in degrees). Range: -360 to 360.
radius	Number (range 1 - 999)	The radius (in pixels). Range: 1 to 999.

undefined applyNTSC ()

Applies the NTSC colors filter.

undefined applyOceanRipple (size:Int, magnitude:Int)

Applies the ocean ripple filter.

Parameter	Type	Description
size	Int (range 1 - 15)	The ripple size. Range: 1 to 15.
magnitude	Int (range 0 - 20)	The ripple magnitude. Range: 0 to 20.

undefined applyOffset (horizontal:UnitValue, vertical:UnitValue, undefinedAreas:OffsetUndefinedAreas)

Applies the offset filter.

Parameter	Type	Description
horizontal	UnitValue	The amount (in pixels) to move the selection horizontally (to the right). Range: -6144 to 6144.
vertical	UnitValue	The amount (in pixels) to move the selection vertically (downward). Range: -6144 to 6144.
undefinedAreas	OffsetUndefinedAreas OffsetUndefinedAreas.SETTOBACKGROUND OffsetUndefinedAreas.WRAPAROUND OffsetUndefinedAreas.REPEATEDGEPIXELS	The method for filling areas left blank by the offset.

Parameter

Type

Description

horizontal

UnitValue

The amount (in pixels) to move the selection horizontally (to the right). Range: -6144 to 6144.

vertical

UnitValue

The amount (in pixels) to move the selection vertically (downward). Range: -6144 to 6144.

undefinedAreas

OffsetUndefinedAreas

OffsetUndefinedAreas.SETTOBACKGROUND

OffsetUndefinedAreas.WRAPAROUND

OffsetUndefinedAreas.REPEATEDGEPIXELS

The method for filling areas left blank by the offset.

undefined applyPinch (amount:Int)

Applies the pinch filter.

Parameter	Type	Description
amount	Int	The pinch amount. Range: -100 to 100.

undefined applyPolarCoordinates (conversion:PolarConversionType)

Applies the polar coordinates filter.

Parameter	Type	Description
conversion	PolarConversionType PolarConversionType.RECTANGULARTOPOLAR PolarConversionType.POLARTORECTANGULAR	The conversion type.

Parameter

Type

Description

conversion

PolarConversionType

PolarConversionType.RECTANGULARTOPOLAR

PolarConversionType.POLARTORECTANGULAR

The conversion type.

undefined applyRadialBlur (amount:Int, blurMethod:RadialBlurMethod, blurQuality:RadialBlurQuality, [blurCenter:UnitPoint])

Applies the radial blur filter.

Parameter	Type	Description
amount	Int (range 1 - 100)	The amount of blur. Range: 1 to 100.
blurMethod	RadialBlurMethod RadialBlurMethod.SPIN RadialBlurMethod.ZOOM	The blur method to use.
blurQuality	RadialBlurQuality RadialBlurQuality.DRAFT RadialBlurQuality.GOOD RadialBlurQuality.BEST	The smoothness or graininess of the blurred image.
blurCenter	UnitPoint	Position (unit value)

undefined applyRipple (amount:Int, size:RippleSize)

Applies the ripple filter.

Parameter	Type	Description
amount	Int	The ripple amount. Range: -999 to 999.
size	RippleSize RippleSize.SMALL RippleSize.MEDIUM RippleSize.LARGE	The ripple size.

Parameter

Type

Description

amount

Int

The ripple amount. Range: -999 to 999.

size

RippleSize

RippleSize.SMALL

RippleSize.MEDIUM

RippleSize.LARGE

The ripple size.

undefined applySharpen ()

Applies the sharpen filter.

undefined applySharpenEdges ()

Applies the sharpen edges filter.

undefined applySharpenMore ()

Applies the sharpen more filter.

undefined applyShear (curve:Array of Varies, undefinedAreas:UndefinedAreas)

Applies the shear filter.

Parameter	Type	Description
curve	Array of Varies	Specification of the shear curve in points as x,y coordinate pairs in the format [[x1, y1],[x2, y2]]. Any number of coordinate pairs can be specified.
undefinedAreas	UndefinedAreas UndefinedAreas.WRAPAROUND UndefinedAreas.REPEATEDGEPIXELS	The treatment of areas left blank by the distortion.

Parameter

Type

Description

curve

Array of Varies

Specification of the shear curve in points as x,y coordinate pairs in the format [[x1, y1],[x2, y2]]. Any number of coordinate pairs can be specified.

undefinedAreas

UndefinedAreas

UndefinedAreas.WRAPAROUND

UndefinedAreas.REPEATEDGEPIXELS

The treatment of areas left blank by the distortion.

undefined applySmartBlur (radius:Number, threshold:Number, blurQuality:SmartBlurQuality, mode:SmartBlurMode)

Applies the smart blur filter.

Parameter	Type	Description
radius	Number	The blur radius. Range: 0 - 1000.
threshold	Number	The blur threshold. Range: 0 - 1000.
blurQuality	SmartBlurQuality SmartBlurQuality.LOW SmartBlurQuality.MEDIUM SmartBlurQuality.HIGH	The smoothness or graininess of the blurred image.
mode	SmartBlurMode SmartBlurMode.NORMAL SmartBlurMode.EDGEONLY SmartBlurMode.OVERLAYEDGE	The smart blur mode.

undefined applySpherize (amount:Int, mode:SpherizeMode)

Applies the spherize filter.

Parameter	Type	Description
amount	Int	The amount of distortion. Range: -100 to 100.
mode	SpherizeMode SpherizeMode.NORMAL SpherizeMode.HORIZONTAL SpherizeMode.VERTICAL	The distortion mode.

Parameter

Type

Description

amount

Int

The amount of distortion. Range: -100 to 100.

mode

SpherizeMode

SpherizeMode.NORMAL

SpherizeMode.HORIZONTAL

SpherizeMode.VERTICAL

The distortion mode.

undefined applyStyle (styleName:String)

Applies the specified style to the layer.

Parameter	Type	Description
styleName	String	The layer style to apply.

undefined applyStyleFile (file:File)

Parameter	Type	Description
file	File	Style file to apply.

undefined applyTextureFill (textureFile:File)

Applies the texture fill filter.

Parameter	Type	Description
textureFile	File	The texture file. Must be a grayscale Photoshop file.

undefined applyTwirl (angle:Int)

Applies the twirl filter.

Parameter	Type	Description
angle	Int	The twirl angle. Range: -999 to 999.

undefined applyUnSharpMask (amount:Number, radius:Number, threshold:Int)

Applies the unsharp mask filter.

Parameter	Type	Description
amount	Number (range 1 - 500)	The amount of sharpening (as a percentage). Range: 1 to 500.
radius	Number	The radius in pixels. Range: 0.1 to 250.0.
threshold	Int (range 0 - 255)	The contrast threshold. Range: 0 to 255.

undefined applyWave (generatorNumber:Int, minimumWavelength:Int, maximumWavelength:Int, minimumAmplitude:Int, maximumAmplitude:Int, horizontalScale:Int, verticalScale:Int, waveType:WaveType, undefinedAreas:UndefinedAreas, randomSeed:Int)

Applies the wave filter.

Parameter	Type	Description
generatorNumber	Int (range 1 - 999)	The number of generators. Range: 1 to 999.
minimumWavelength	Int (range 1 - 998)	The minimum wave length. Range: 1 to 998.
maximumWavelength	Int	The maximum wave length. Range: 2 to (minimum wavelength + 1)
minimumAmplitude	Int (range 1 - 998)	The minimum amplitude. Range: 1 to 998.
maximumAmplitude	Int	The maximum amplitude. Range: 2 to (minimum amplitude + 1)
horizontalScale	Int (range 1 - 100)	The amount of horizontal scale (as a percentage). Range: 1 to 100.
verticalScale	Int (range 1 - 100)	The amount of vertical scale (as a percentage). Range: 1 to 100.
waveType	WaveType WaveType.SINE WaveType.TRIANGULAR WaveType.SQUARE	The wave type.
undefinedAreas	UndefinedAreas UndefinedAreas.WRAPAROUND UndefinedAreas.REPEATEDGEPIXELS	The treatment of areas left blank by the distortion.
randomSeed	Int	The random seed.

undefined applyZigZag (amount:Int, ridges:Int, style:ZigZagType)

Applies the zigzag filter.

Parameter	Type	Description
amount	Int	The amount of zigzag. Range: -100 to 100.
ridges	Int	The ridge length.
style	ZigZagType ZigZagType.AROUNDCENTER ZigZagType.OUTFROMCENTER ZigZagType.PONDRIPPLES	The zigzag style.

Parameter

Type

Description

amount

Int

The amount of zigzag. Range: -100 to 100.

ridges

Int

The ridge length.

style

ZigZagType

ZigZagType.AROUNDCENTER

ZigZagType.OUTFROMCENTER

ZigZagType.PONDRIPPLES

The zigzag style.

undefined autoContrast ()

Adjusts the contrast of the selected channels automatically.

undefined autoLevels ()

Adjust the levels of the selected channels using the auto levels option.

undefined clear ()

Cuts the layer without moving it to the clipboard.

undefined copy ([merge:Boolean=Boolean])

Copies the layer to the clipboard.

Parameter	Type	Description
merge	Boolean	If true, the copy includes all visible layers. If false, the copy only copies from the current layer. (default: false)

Parameter

Type

Description

merge

Boolean

If true, the copy includes all visible layers. If false, the copy only copies from the current layer.

(default: false)

undefined cut ()

Cuts the layer to the clipboard.

undefined desaturate ()

Converts a color image to a grayscale image in the current color mode by assigning equal values of each component color to each pixel.

undefined equalize ()

Redistributes the brightness values of pixels in an image to more evenly represent the entire range of brightness levels within the image.

undefined invert ()

Inverts the colors in the layer by converting the brightness value of each pixel in the channels to the inverse value on the 256-step color-values scale.

ArtLayer merge ()

Merges the layer down, removing the layer from the document. Returns a reference to the art layer that this layer is merged into.

undefined mixChannels (outputChannels:Array of Varies, [monochrome:Boolean=Boolean])

Modifies a targeted (output) color channel using a mix of the existing color channels in the image. (output channels = An array of channel specifications. For each component channel, specify a list of adjustment values (-200 to 200) followed by a 'constant' value (-200 to 200).) When monochrome = true, the maximum number of channel value specifications is 1. Valid only when 'document mode' = RGB or CMYK. RGB arrays must include four doubles. CMYK arrays must include five doubles.

Parameter	Type	Description
outputChannels	Array of Varies	A list of channel specifications. For each component channel that the document has, you must specify a list of adjustment values followed by a 'constant' value.
monochrome	Boolean	If true, uses monochrome mixing. Note: If this is true, you can only specify one channel value. (default: false)

Parameter

Type

Description

outputChannels

Array of Varies

A list of channel specifications. For each component channel that the document has, you must specify a list of adjustment values followed by a 'constant' value.

monochrome

Boolean

If true, uses monochrome mixing. Note: If this is true, you can only specify one channel value.

(default: false)

undefined photoFilter ([fillColor:SolidColor], [density:Int=Int], [preserveLuminosity:Boolean=Boolean])

Adjusts the layer's color balance and temperature as if a color filter had been applied.

Parameter	Type	Description
fillColor	SolidColor	The color to use for the fill.
density	Int (range 1 - 100)	The density (as a percentage) of the filter effect. Range: 1 to 100. (default: 25)
preserveLuminosity	Boolean	If true, luminosity is preserved. (default: true)

Parameter

Type

Description

fillColor

SolidColor

The color to use for the fill.

density

Int (range 1 - 100)

The density (as a percentage) of the filter effect. Range: 1 to 100.

(default: 25)

preserveLuminosity

Boolean

If true, luminosity is preserved.

(default: true)

undefined posterize (levels:Int)

Specifies the number of tonal levels for each channel and then maps pixels to the closest matching level.

Parameter	Type	Description
levels	Int (range 2 - 255)	The tonal levels. Range: 2 to 255.

undefined rasterize (target:RasterizeType)

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

Parameter	Type	Description
target	RasterizeType RasterizeType.TEXTCONTENTS RasterizeType.SHAPE RasterizeType.FILLCONTENT RasterizeType.LAYERCLIPPINGPATH RasterizeType.ENTIRELAYER RasterizeType.LINKEDLAYERS	What to rasterize.

Parameter

Type

Description

target

RasterizeType

RasterizeType.TEXTCONTENTS

RasterizeType.SHAPE

RasterizeType.FILLCONTENT

RasterizeType.LAYERCLIPPINGPATH

RasterizeType.ENTIRELAYER

RasterizeType.LINKEDLAYERS

What to rasterize.

undefined saveStyleFile (file:File, [thumbnail:File], [thumbnailSize:Int], [backgroundValue:Number])

Parameter	Type	Description
file	File	File to save the style to.
thumbnail	File	File to save the style thumbnail to.
thumbnailSize	Int	Size of thumbnail to save.
backgroundValue	Number	Background grayvalue.

undefined selectiveColor (selectionMethod:AdjustmentReference, [reds:Array of Number], [yellows:Array of Number], [greens:Array of Number], [cyans:Array of Number], [blues:Array of Number], [magentas:Array of Number], [whites:Array of Number], [neutrals:Array of Number], [blacks:Array of Number])

Parameter	Type	Description
selectionMethod	AdjustmentReference AdjustmentReference.RELATIVE AdjustmentReference.ABSOLUTE	Modifies the amount of a process color in a specified primary color without affecting the other primary colors.
reds	Array of Number	Array of 4 values: cyan, magenta, yellow, black.
yellows	Array of Number	Array of 4 values: cyan, magenta, yellow, black.
greens	Array of Number	Array of 4 values: cyan, magenta, yellow, black.
cyans	Array of Number	Array of 4 values: cyan, magenta, yellow, black.
blues	Array of Number	Array of 4 values: cyan, magenta, yellow, black.
magentas	Array of Number	Array of 4 values: cyan, magenta, yellow, black.
whites	Array of Number	Array of 4 values: cyan, magenta, yellow, black.
neutrals	Array of Number	Array of 4 values: cyan, magenta, yellow, black.
blacks	Array of Number	Array of 4 values: cyan, magenta, yellow, black.

undefined shadowHighlight ([shadowAmount:Int=Int], [shadowWidth:Int=Int], [shadowRaduis:Int=Int], [highlightAmount:Int=Int], [highlightWidth:Int=Int], [highlightRaduis:Int=Int], [colorCorrection:Int=Int], [midtoneContrast:Int=Int], [blackClip:Number=Number], [whiteClip:Number=Number])

Adjusts the range of tones in the shadows and highlights.

Parameter	Type	Description
shadowAmount	Int (range 0 - 100)	The shadow amount, as a percentage. Range: 0 to 100. (default: 50)
shadowWidth	Int (range 0 - 100)	The shadow width, as a percentage. Range: 0 to 100 for tonal width (0 = narrow), (100 = broad). (default: 50)
shadowRaduis	Int (range 0 - 2500)	The shadow radius (in pixels). Range: 0 to 2500. (default: 30)
highlightAmount	Int (range 0 - 100)	The highlight amount, as a percentage. Range: 0 to 100. (default: 0)
highlightWidth	Int (range 0 - 100)	The highlight width. Range: 0 to 100 for tonal width (0 = narrow), (100 = broad). (default: 50)
highlightRaduis	Int (range 0 - 2500)	The highlight radius (in pixels). Range: 0 to 2500. (default: 30)
colorCorrection	Int	The amount to adjust the colors in the changed portion of the image. Range: -100 to 100. (default: 20)
midtoneContrast	Int	The amount of midtone contrast. Range: -100 to 100. (default: 0)
blackClip	Number	Fractions of whites to be clipped. Range: 0.000 to 50.000. (default: 0.01)
whiteClip	Number	Fractions of blacks to be clipped. Range: 0.000 to 50.000. (default: 0.01)

undefined threshold (level:Int)

Converts grayscale or color images to high-contrast, B/W images by converting pixels lighter than the specified threshold to white and pixels darker than the threshold to black.

Parameter	Type	Description
level	Int	The threshold level.

Object of

Document.backgroundLayer

Return

ArtLayers.add()

ArtLayer.add()

ArtLayers.[]()

ArtLayers.getByName()

ArtLayer.merge()

LayerSet.merge()

Document.paste()