Packagecom.adobe.photoshop
Classpublic class ArtLayer
InheritanceArtLayer Inheritance Layer Inheritance PhotoshopHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

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



Public Properties
 PropertyDefined By
 InheritedallLocked : Boolean
If true, the layer's contents and settings are locked.
Layer
 InheritedblendMode : BlendMode
The mode to use when compositing an object.
Layer
 Inheritedbounds : Array
[read-only] Bounding rectangle of the Layer.
Layer
  fillOpacity : Number
The interior opacity of the layer.
ArtLayer
  filterMaskDensity : Number
The density of the filter mask.
ArtLayer
  filterMaskFeather : Number
The feather of the filter mask.
ArtLayer
  grouped : Boolean
If true, the layer is grouped with the layer below.
ArtLayer
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isBackgroundLayer : Boolean
If true, the layer is a background layer.
ArtLayer
  kind : LayerKind
Sets the layer kind (such as 'text layer') for an empty layer.
ArtLayer
  layerMaskDensity : Number
The density of the layer mask.
ArtLayer
  layerMaskFeather : Number
The feather of the layer mask.
ArtLayer
 InheritedlinkedLayers : Array
[read-only] The layers linked to this layer.
Layer
 Inheritedname : String
The name of the layer.
Layer
 Inheritedopacity : Number
The layer's master opacity (as a percentage).
Layer
 Inheritedparent : *
[read-only]
PhotoshopHostObject
  pixelsLocked : Boolean
If true, the pixels in the layer's image cannot be edited.
ArtLayer
  positionLocked : Boolean
If true, the pixels in the layer's image cannot be moved within the layer.
ArtLayer
  textItem : TextItem
[read-only] The text that is associated with the layer.
ArtLayer
  transparentPixelsLocked : Boolean
If true, editing is confined to the opaque portions of the layer.
ArtLayer
  vectorMaskDensity : Number
The density of the vector mask.
ArtLayer
  vectorMaskFeather : Number
The feather of the vector mask.
ArtLayer
 Inheritedvisible : Boolean
If true, the layer is visible.
Layer
 InheritedxmpMetadata : XmpMetadata
[read-only] The XMP properties of the document.
Layer
Public Methods
 MethodDefined By
  
adjustBrightnessContrast(brightness:Number, contrast:Number):void
Adjusts the brightness and constrast.
ArtLayer
  
adjustColorBalance(shadows:Object = null, midtones:Object = null, highlights:Object = null, preserveLuminosity:Boolean):void
Adjusts the color balance of the layer's component channels.
ArtLayer
  
adjustCurves(curveShape:Object):void
Adjusts the tonal range of the selected channel using up to fourteen points.
ArtLayer
  
adjustLevels(inputRangeStart:Number, inputRangeEnd:Number, inputRangeGamma:Number, outputRangeStart:Number, outputRangeEnd:Number):void
Adjusts levels of the selected channels.
ArtLayer
  
applyAddNoise(amount:Number, distribution:NoiseDistribution, monochromatic:Boolean):void
Applies the add noise filter.
ArtLayer
  
Applies the average filter.
ArtLayer
  
applyBlur():void
Applies the blur filter.
ArtLayer
  
Applies the blur more filter.
ArtLayer
  
Applies the clouds filter.
ArtLayer
  
applyCustomFilter(characteristics:Object, scale:Number, offset:Number):void
Applies the custom filter.
ArtLayer
  
applyDeInterlace(eliminateFields:EliminateFields, createFields:CreateFields):void
Applies the de-interlace filter.
ArtLayer
  
Applies the despeckle filter.
ArtLayer
  
Applies the difference clouds filter.
ArtLayer
  
applyDiffuseGlow(graininess:Number, glowAmount:Number, clearAmount:Number):void
Applies the diffuse glow filter.
ArtLayer
  
applyDisplace(horizontalScale:Number, verticalScale:Number, displacementType:DisplacementMapType, undefinedAreas:UndefinedAreas, displacementMapFile:File):void
Applies the displace filter.
ArtLayer
  
applyDustAndScratches(radius:Number, threshold:Number):void
Applies the dust and scratches filter.
ArtLayer
  
applyGaussianBlur(radius:Number):void
Applies the gaussian blur filter.
ArtLayer
  
applyGlassEffect(distortion:Number, smoothness:Number, scaling:Number, invert:Boolean = false, texture:TextureType = null, textureFile:File = null):void
Applies the glass filter.
ArtLayer
  
applyHighPass(radius:Number):void
Applies the high pass filter.
ArtLayer
  
applyLensBlur(source:DepthMapSource = null, focalDistance:Number = 0, invertDepthMap:Boolean = false, shape:Geometry = null, radius:Number = 15, bladeCurvature:Number = 0, rotation:Number = 0, brightness:Number = 0, threshold:Number = 0, amount:Number = 0, distribution:NoiseDistribution = null, monochromatic:Boolean = false):void
Apply the lens blur filter.
ArtLayer
  
applyLensFlare(brightness:Number, flareCenter:Array, lensType:LensType):void
Applies the lens flare filter.
ArtLayer
  
applyMaximum(radius:Number):void
Applies the maximum filter.
ArtLayer
  
applyMedianNoise(radius:Number):void
Applies the median noise filter.
ArtLayer
  
applyMinimum(radius:Number):void
Applies the minimum filter.
ArtLayer
  
applyMotionBlur(angle:Number, radius:Number):void
Applies the motion blur filter.
ArtLayer
  
applyNTSC():void
Applies the NTSC colors filter.
ArtLayer
  
applyOceanRipple(size:Number, magnitude:Number):void
Applies the ocean ripple filter.
ArtLayer
  
applyOffset(horizontal:String, vertical:String, undefinedAreas:OffsetUndefinedAreas):void
Applies the offset filter.
ArtLayer
  
applyPinch(amount:Number):void
Applies the pinch filter.
ArtLayer
  
Applies the polar coordinates filter.
ArtLayer
  
applyRadialBlur(amount:Number, blurMethod:RadialBlurMethod, blurQuality:RadialBlurQuality):void
Applies the radial blur filter.
ArtLayer
  
applyRipple(amount:Number, size:RippleSize):void
Applies the ripple filter.
ArtLayer
  
Applies the sharpen filter.
ArtLayer
  
Applies the sharpen edges filter.
ArtLayer
  
Applies the sharpen more filter.
ArtLayer
  
applyShear(curve:Object, undefinedAreas:UndefinedAreas):void
Applies the shear filter.
ArtLayer
  
applySmartBlur(radius:Number, threshold:Number, blurQuality:SmartBlurQuality, mode:SmartBlurMode):void
Applies the smart blur filter.
ArtLayer
  
applySpherize(amount:Number, mode:SpherizeMode):void
Applies the spherize filter.
ArtLayer
  
applyStyle(styleName:String):void
Applies the specified style to the layer.
ArtLayer
  
applyTextureFill(textureFile:File):void
Applies the texture fill filter.
ArtLayer
  
applyTwirl(angle:Number):void
Applies the twirl filter.
ArtLayer
  
applyUnSharpMask(amount:Number, radius:Number, threshold:Number):void
Applies the unsharp mask filter.
ArtLayer
  
applyWave(generatorNumber:Number, minimumWavelength:Number, maximumWavelength:Number, minimumAmplitude:Number, maximumAmplitude:Number, horizontalScale:Number, verticalScale:Number, waveType:WaveType, undefinedAreas:UndefinedAreas, randomSeed:Number):void
Applies the wave filter.
ArtLayer
  
applyZigZag(amount:Number, ridges:Number, style:ZigZagType):void
Applies the zigzag filter.
ArtLayer
  
Adjusts the contrast of the selected channels automatically.
ArtLayer
  
autoLevels():void
Adjust the levels of the selected channels using the auto levels option.
ArtLayer
  
clear():void
Cuts the layer without moving it to the clipboard.
ArtLayer
  
copy(merge:Boolean = false):void
Copies the layer to the clipboard.
ArtLayer
  
cut():void
Cuts the layer to the clipboard.
ArtLayer
  
desaturate():void
Converts a color image to a grayscale image in the current color mode by assigning equal values of each component color to each pixel.
ArtLayer
 Inherited
duplicate(relativeObject:Object = null, insertionLocation:ElementPlacement = null):Layer
create a duplicate of the object
Layer
  
equalize():void
Redistributes the brightness values of pixels in an image to more evenly represent the entire range of brightness levels within the image.
ArtLayer
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
invert():void
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
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
 Inherited
link(_with:Layer):void
Links the layer with the specified layer.
Layer
  
Merges the layer down, removing the layer from the document.
ArtLayer
  
mixChannels(outputChannels:Object, monochrome:Boolean = false):void
Modifies a targeted (output) color channel using a mix of the existing color channels in the image.
ArtLayer
 Inherited
move(relativeObject:Object, insertionLocation:ElementPlacement):void
move the object
Layer
  
photoFilter(fillColor:SolidColor = null, density:Number = 25, preserveLuminosity:Boolean = true):void
Adjusts the layer's color balance and temperature as if a color filter had been applied.
ArtLayer
  
posterize(levels:Number):void
Specifies the number of tonal levels for each channel and then maps pixels to the closest matching level.
ArtLayer
  
Converts the targeted content in the layer into a flat, raster image.
ArtLayer
 Inherited
remove():void
delete the object
Layer
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
resize(horizontal:Number = 100, vertical:Number = 100, anchor:AnchorPosition = null):void
Scales the object.
Layer
 Inherited
rotate(angle:Number, anchor:AnchorPosition = null):void
Rotates the object.
Layer
  
selectiveColor(selectionMethod:AdjustmentReference, reds:Object = null, yellows:Object = null, greens:Object = null, cyans:Object = null, blues:Object = null, magentas:Object = null, whites:Object = null, neutrals:Object = null, blacks:Object = null):void
ArtLayer
  
shadowHighlight(shadowAmount:Number = 50, shadowWidth:Number = 50, shadowRaduis:Number = 30, highlightAmount:Number = 0, highlightWidth:Number = 50, highlightRaduis:Number = 30, colorCorrection:Number = 20, midtoneContrast:Number = 0, blackClip:Number = 0.01, whiteClip:Number = 0.01):void
Adjusts the range of tones in the shadows and highlights.
ArtLayer
  
threshold(level:Number):void
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.
ArtLayer
 Inherited
translate(deltaX:String = null, deltaY:String = null):void
Moves the object relative to its current position.
Layer
 Inherited
unlink():void
Unlinks the layer.
Layer
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
fillOpacityproperty
fillOpacity:Number

The interior opacity of the layer. Range: 0.0 to 100.0.


Implementation
    public function get fillOpacity():Number
    public function set fillOpacity(value:Number):void
filterMaskDensityproperty 
filterMaskDensity:Number

The density of the filter mask. Range: 0.0 and 100.0.


Implementation
    public function get filterMaskDensity():Number
    public function set filterMaskDensity(value:Number):void
filterMaskFeatherproperty 
filterMaskFeather:Number

The feather of the filter mask. Range: 0.0 and 250.0.


Implementation
    public function get filterMaskFeather():Number
    public function set filterMaskFeather(value:Number):void
groupedproperty 
grouped:Boolean

If true, the layer is grouped with the layer below.


Implementation
    public function get grouped():Boolean
    public function set grouped(value:Boolean):void
isBackgroundLayerproperty 
isBackgroundLayer:Boolean

If true, the layer is a background layer.


Implementation
    public function get isBackgroundLayer():Boolean
    public function set isBackgroundLayer(value:Boolean):void
kindproperty 
kind:LayerKind

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.


Implementation
    public function get kind():LayerKind
    public function set kind(value:LayerKind):void
layerMaskDensityproperty 
layerMaskDensity:Number

The density of the layer mask. Range: 0.0 to 100.0.


Implementation
    public function get layerMaskDensity():Number
    public function set layerMaskDensity(value:Number):void
layerMaskFeatherproperty 
layerMaskFeather:Number

The feather of the layer mask. Range: 0.0 and 250.0.


Implementation
    public function get layerMaskFeather():Number
    public function set layerMaskFeather(value:Number):void
pixelsLockedproperty 
pixelsLocked:Boolean

If true, the pixels in the layer's image cannot be edited.


Implementation
    public function get pixelsLocked():Boolean
    public function set pixelsLocked(value:Boolean):void
positionLockedproperty 
positionLocked:Boolean

If true, the pixels in the layer's image cannot be moved within the layer.


Implementation
    public function get positionLocked():Boolean
    public function set positionLocked(value:Boolean):void
textItemproperty 
textItem:TextItem  [read-only]

The text that is associated with the layer. Valid only when 'kind' is text layer.


Implementation
    public function get textItem():TextItem
transparentPixelsLockedproperty 
transparentPixelsLocked:Boolean

If true, editing is confined to the opaque portions of the layer.


Implementation
    public function get transparentPixelsLocked():Boolean
    public function set transparentPixelsLocked(value:Boolean):void
vectorMaskDensityproperty 
vectorMaskDensity:Number

The density of the vector mask. Range: 0.0 and 100.0.


Implementation
    public function get vectorMaskDensity():Number
    public function set vectorMaskDensity(value:Number):void
vectorMaskFeatherproperty 
vectorMaskFeather:Number

The feather of the vector mask. Range: 0.0 and 250.0.


Implementation
    public function get vectorMaskFeather():Number
    public function set vectorMaskFeather(value:Number):void
Method Detail
adjustBrightnessContrast()method
public function adjustBrightnessContrast(brightness:Number, contrast:Number):void

Adjusts the brightness and constrast.

Parameters

brightness:Number — (Number) The brightness amount. Range: -100 to 100.
 
contrast:Number — (Number) The contrast amount. Range: -100 to 100.

adjustColorBalance()method 
public function adjustColorBalance(shadows:Object = null, midtones:Object = null, highlights:Object = null, preserveLuminosity:Boolean):void

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

Parameters

shadows:Object (default = null) — (Object) 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:Object (default = null) — (Object) 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:Object (default = null) — (Object) 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 (default = NaN) — (Boolean) If true, luminosity is preserved.

adjustCurves()method 
public function adjustCurves(curveShape:Object):void

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

Parameters

curveShape:Object — (Object) The curve points. The number of points must be between 2 and 14.

adjustLevels()method 
public function adjustLevels(inputRangeStart:Number, inputRangeEnd:Number, inputRangeGamma:Number, outputRangeStart:Number, outputRangeEnd:Number):void

Adjusts levels of the selected channels.

Parameters

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

applyAddNoise()method 
public function applyAddNoise(amount:Number, distribution:NoiseDistribution, monochromatic:Boolean):void

Applies the add noise filter.

Parameters

amount:Number — (Number) The amount of noise (as a percentage). Range: 0.1 to 400.0.
 
distribution:NoiseDistribution — (com.adobe.photoshop.NoiseDistribution) The noise distribution type.
 
monochromatic:Boolean — (Boolean) If true, applies the filter only to the tonal elements in the image without changing the colors.

applyAverage()method 
public function applyAverage():void

Applies the average filter.

applyBlur()method 
public function applyBlur():void

Applies the blur filter.

applyBlurMore()method 
public function applyBlurMore():void

Applies the blur more filter.

applyClouds()method 
public function applyClouds():void

Applies the clouds filter.

applyCustomFilter()method 
public function applyCustomFilter(characteristics:Object, scale:Number, offset:Number):void

Applies the custom filter.

Parameters

characteristics:Object — (Object) 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:Number — (Number) The value by which to divide the sum of the brightness values of the pixels included in the calculation.
 
offset:Number — (Number) The value to be added to the result of the scale calculation.

applyDeInterlace()method 
public function applyDeInterlace(eliminateFields:EliminateFields, createFields:CreateFields):void

Applies the de-interlace filter.

Parameters

eliminateFields:EliminateFields — (com.adobe.photoshop.EliminateFields) The fields to eliminate.
 
createFields:CreateFields — (com.adobe.photoshop.CreateFields) The method to use to replace eliminated fields.

applyDespeckle()method 
public function applyDespeckle():void

Applies the despeckle filter.

applyDifferenceClouds()method 
public function applyDifferenceClouds():void

Applies the difference clouds filter.

applyDiffuseGlow()method 
public function applyDiffuseGlow(graininess:Number, glowAmount:Number, clearAmount:Number):void

Applies the diffuse glow filter.

Parameters

graininess:Number — (Number) The amount of graininess. Range: 0 to 10.
 
glowAmount:Number — (Number) The glow amount. Range: 0 to 20.
 
clearAmount:Number — (Number) The clear amount. Range: 0 to 20.

applyDisplace()method 
public function applyDisplace(horizontalScale:Number, verticalScale:Number, displacementType:DisplacementMapType, undefinedAreas:UndefinedAreas, displacementMapFile:File):void

Applies the displace filter.

Parameters

horizontalScale:Number — (Number) The amount of horizontal distortion. Range: -999 to 999.
 
verticalScale:Number — (Number) The amount of vertical distortion. Range: -999 to 999.
 
displacementType:DisplacementMapType — (com.adobe.photoshop.DisplacementMapType) The displacement type.
 
undefinedAreas:UndefinedAreas — (com.adobe.photoshop.UndefinedAreas) The treatment of undistorted areas.
 
displacementMapFile:File — (flash.filesystem.File) The distortion image map.

applyDustAndScratches()method 
public function applyDustAndScratches(radius:Number, threshold:Number):void

Applies the dust and scratches filter.

Parameters

radius:Number — (Number) The size (in pixels) of the area searched for dissimilar pixels. Range: 1 to 16.
 
threshold:Number — (Number) Determines how dissimilar the pixels should be before they are eliminated. Range: 0 to 255.

applyGaussianBlur()method 
public function applyGaussianBlur(radius:Number):void

Applies the gaussian blur filter.

Parameters

radius:Number — (Number) The blur width in pixels. Range: 1.0 to 250.0.

applyGlassEffect()method 
public function applyGlassEffect(distortion:Number, smoothness:Number, scaling:Number, invert:Boolean = false, texture:TextureType = null, textureFile:File = null):void

Applies the glass filter.

Parameters

distortion:Number — (Number) The amount of distortion. Range: 0 to 20.
 
smoothness:Number — (Number) The smoothness. Range: 1 to 15.
 
scaling:Number — (Number) The amount of scaling. Range: 50 to 200.
 
invert:Boolean (default = false) — (Boolean) If true, the texture is inverted. ( default: false )
 
texture:TextureType (default = null) — (com.adobe.photoshop.TextureType) The type of texture.
 
textureFile:File (default = null) — (flash.filesystem.File) The file from which to load the texture type.

applyHighPass()method 
public function applyHighPass(radius:Number):void

Applies the high pass filter.

Parameters

radius:Number — (Number) The width (in pixels) of the radius where edge details are retained.

applyLensBlur()method 
public function applyLensBlur(source:DepthMapSource = null, focalDistance:Number = 0, invertDepthMap:Boolean = false, shape:Geometry = null, radius:Number = 15, bladeCurvature:Number = 0, rotation:Number = 0, brightness:Number = 0, threshold:Number = 0, amount:Number = 0, distribution:NoiseDistribution = null, monochromatic:Boolean = false):void

Apply the lens blur filter.

Parameters

source:DepthMapSource (default = null) — (com.adobe.photoshop.DepthMapSource) The source for the depth map. ( default: DepthMapSource.NONE )
 
focalDistance:Number (default = 0) — (Number) 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 (default = false) — (Boolean) If true, inverts the depth map. ( default: false )
 
shape:Geometry (default = null) — (com.adobe.photoshop.Geometry) The shape of the iris. ( default: Geometry.HEXAGON )
 
radius:Number (default = 15) — (Number) The radius of the iris. Range: 0 to 100. ( default: 15 )
 
bladeCurvature:Number (default = 0) — (Number) The blade curvature of the iris. Range: 0 to 100. ( default: 0 )
 
rotation:Number (default = 0) — (Number) The rotation of the iris (in degrees). Range: 0 to 360. ( default: 0 )
 
brightness:Number (default = 0) — (Number) The brightness for the specular highlights. Range: 0 to 100. ( default: 0 )
 
threshold:Number (default = 0) — (Number) The threshold for the specular highlights. Range: 0 to 255. ( default: 0 )
 
amount:Number (default = 0) — (Number) The amount of noise. Range: 0 to 100. ( default: 0 )
 
distribution:NoiseDistribution (default = null) — (com.adobe.photoshop.NoiseDistribution) The distribution value for the noise. ( default: NoiseDistribution.UNIFORM )
 
monochromatic:Boolean (default = false) — (Boolean) If true, the noise is monochromatic. ( default: false )

applyLensFlare()method 
public function applyLensFlare(brightness:Number, flareCenter:Array, lensType:LensType):void

Applies the lens flare filter.

Parameters

brightness:Number — (Number) The flare brightness. Range: 10 to 300.
 
flareCenter:Array — (Array) The position of the flare center.
 
lensType:LensType — (com.adobe.photoshop.LensType) The lens type.

applyMaximum()method 
public function applyMaximum(radius:Number):void

Applies the maximum filter.

Parameters

radius:Number — (Number) The choke area (in pixels). Range: 0 to 100.

applyMedianNoise()method 
public function applyMedianNoise(radius:Number):void

Applies the median noise filter.

Parameters

radius:Number — (Number) The size of the area searched for pixels of similar brightness. Range: 0 to 100.

applyMinimum()method 
public function applyMinimum(radius:Number):void

Applies the minimum filter.

Parameters

radius:Number — (Number) The spread area (in pixels). Range: 0 to 100.

applyMotionBlur()method 
public function applyMotionBlur(angle:Number, radius:Number):void

Applies the motion blur filter.

Parameters

angle:Number — (Number) The angle (in degrees). Range: -360 to 360.
 
radius:Number — (Number) The radius (in pixels). Range: 1 to 999.

applyNTSC()method 
public function applyNTSC():void

Applies the NTSC colors filter.

applyOceanRipple()method 
public function applyOceanRipple(size:Number, magnitude:Number):void

Applies the ocean ripple filter.

Parameters

size:Number — (Number) The ripple size. Range: 1 to 15.
 
magnitude:Number — (Number) The ripple magnitude. Range: 0 to 20.

applyOffset()method 
public function applyOffset(horizontal:String, vertical:String, undefinedAreas:OffsetUndefinedAreas):void

Applies the offset filter.

Parameters

horizontal:String — (String) The amount (in pixels) to move the selection horizontally (to the right). Range: -6144 to 6144.
 
vertical:String — (String) The amount (in pixels) to move the selection vertically (downward). Range: -6144 to 6144.
 
undefinedAreas:OffsetUndefinedAreas — (com.adobe.photoshop.OffsetUndefinedAreas) The method for filling areas left blank by the offset.

applyPinch()method 
public function applyPinch(amount:Number):void

Applies the pinch filter.

Parameters

amount:Number — (Number) The pinch amount. Range: -100 to 100.

applyPolarCoordinates()method 
public function applyPolarCoordinates(conversion:PolarConversionType):void

Applies the polar coordinates filter.

Parameters

conversion:PolarConversionType — (com.adobe.photoshop.PolarConversionType) The conversion type.

applyRadialBlur()method 
public function applyRadialBlur(amount:Number, blurMethod:RadialBlurMethod, blurQuality:RadialBlurQuality):void

Applies the radial blur filter.

Parameters

amount:Number — (Number) The amount of blur. Range: 1 to 100.
 
blurMethod:RadialBlurMethod — (com.adobe.photoshop.RadialBlurMethod) The blur method to use.
 
blurQuality:RadialBlurQuality — (com.adobe.photoshop.RadialBlurQuality) The smoothness or graininess of the blurred image.

applyRipple()method 
public function applyRipple(amount:Number, size:RippleSize):void

Applies the ripple filter.

Parameters

amount:Number — (Number) The ripple amount. Range: -999 to 999.
 
size:RippleSize — (com.adobe.photoshop.RippleSize) The ripple size.

applySharpen()method 
public function applySharpen():void

Applies the sharpen filter.

applySharpenEdges()method 
public function applySharpenEdges():void

Applies the sharpen edges filter.

applySharpenMore()method 
public function applySharpenMore():void

Applies the sharpen more filter.

applyShear()method 
public function applyShear(curve:Object, undefinedAreas:UndefinedAreas):void

Applies the shear filter.

Parameters

curve:Object — (Object) 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 — (com.adobe.photoshop.UndefinedAreas) The treatment of areas left blank by the distortion.

applySmartBlur()method 
public function applySmartBlur(radius:Number, threshold:Number, blurQuality:SmartBlurQuality, mode:SmartBlurMode):void

Applies the smart blur filter.

Parameters

radius:Number — (Number) The blur radius. Range: 0 - 1000.
 
threshold:Number — (Number) The blur threshold. Range: 0 - 1000.
 
blurQuality:SmartBlurQuality — (com.adobe.photoshop.SmartBlurQuality) The smoothness or graininess of the blurred image.
 
mode:SmartBlurMode — (com.adobe.photoshop.SmartBlurMode) The smart blur mode.

applySpherize()method 
public function applySpherize(amount:Number, mode:SpherizeMode):void

Applies the spherize filter.

Parameters

amount:Number — (Number) The amount of distortion. Range: -100 to 100.
 
mode:SpherizeMode — (com.adobe.photoshop.SpherizeMode) The distortion mode.

applyStyle()method 
public function applyStyle(styleName:String):void

Applies the specified style to the layer.

Parameters

styleName:String — (String) The layer style to apply.

applyTextureFill()method 
public function applyTextureFill(textureFile:File):void

Applies the texture fill filter.

Parameters

textureFile:File — (flash.filesystem.File) The texture file. Must be a grayscale Photoshop file.

applyTwirl()method 
public function applyTwirl(angle:Number):void

Applies the twirl filter.

Parameters

angle:Number — (Number) The twirl angle. Range: -999 to 999.

applyUnSharpMask()method 
public function applyUnSharpMask(amount:Number, radius:Number, threshold:Number):void

Applies the unsharp mask filter.

Parameters

amount:Number — (Number) The amount of sharpening (as a percentage). Range: 1 to 500.
 
radius:Number — (Number) The radius in pixels. Range: 0.1 to 250.0.
 
threshold:Number — (Number) The contrast threshold. Range: 0 to 255.

applyWave()method 
public function applyWave(generatorNumber:Number, minimumWavelength:Number, maximumWavelength:Number, minimumAmplitude:Number, maximumAmplitude:Number, horizontalScale:Number, verticalScale:Number, waveType:WaveType, undefinedAreas:UndefinedAreas, randomSeed:Number):void

Applies the wave filter.

Parameters

generatorNumber:Number — (Number) The number of generators. Range: 1 to 999.
 
minimumWavelength:Number — (Number) The minimum wave length. Range: 1 to 998.
 
maximumWavelength:Number — (Number) The maximum wave length. Range: 2 to (minimum wavelength + 1)
 
minimumAmplitude:Number — (Number) The minimum amplitude. Range: 1 to 998.
 
maximumAmplitude:Number — (Number) The maximum amplitude. Range: 2 to (minimum amplitude + 1)
 
horizontalScale:Number — (Number) The amount of horizontal scale (as a percentage). Range: 1 to 100.
 
verticalScale:Number — (Number) The amount of vertical scale (as a percentage). Range: 1 to 100.
 
waveType:WaveType — (com.adobe.photoshop.WaveType) The wave type.
 
undefinedAreas:UndefinedAreas — (com.adobe.photoshop.UndefinedAreas) The treatment of areas left blank by the distortion.
 
randomSeed:Number — (Number) The random seed.

applyZigZag()method 
public function applyZigZag(amount:Number, ridges:Number, style:ZigZagType):void

Applies the zigzag filter.

Parameters

amount:Number — (Number) The amount of zigzag. Range: -100 to 100.
 
ridges:Number — (Number) The ridge length.
 
style:ZigZagType — (com.adobe.photoshop.ZigZagType) The zigzag style.

autoContrast()method 
public function autoContrast():void

Adjusts the contrast of the selected channels automatically.

autoLevels()method 
public function autoLevels():void

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

clear()method 
public function clear():void

Cuts the layer without moving it to the clipboard.

copy()method 
public function copy(merge:Boolean = false):void

Copies the layer to the clipboard.

Parameters

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

cut()method 
public function cut():void

Cuts the layer to the clipboard.

desaturate()method 
public function desaturate():void

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

equalize()method 
public function equalize():void

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

invert()method 
public function invert():void

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.

merge()method 
public function merge():ArtLayer

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

Returns
ArtLayer
mixChannels()method 
public function mixChannels(outputChannels:Object, monochrome:Boolean = false):void

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.

Parameters

outputChannels:Object — (Object) 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 (default = false) — (Boolean) If true, uses monochrome mixing. Note: If this is true, you can only specify one channel value. ( default: false )

photoFilter()method 
public function photoFilter(fillColor:SolidColor = null, density:Number = 25, preserveLuminosity:Boolean = true):void

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

Parameters

fillColor:SolidColor (default = null) — (com.adobe.photoshop.SolidColor) The color to use for the fill.
 
density:Number (default = 25) — (Number) The density (as a percentage) of the filter effect. Range: 1 to 100. ( default: 25 )
 
preserveLuminosity:Boolean (default = true) — (Boolean) If true, luminosity is preserved. ( default: true )

posterize()method 
public function posterize(levels:Number):void

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

Parameters

levels:Number — (Number) The tonal levels. Range: 2 to 255.

rasterize()method 
public function rasterize(target:RasterizeType):void

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

Parameters

target:RasterizeType — (com.adobe.photoshop.RasterizeType) What to rasterize.

selectiveColor()method 
public function selectiveColor(selectionMethod:AdjustmentReference, reds:Object = null, yellows:Object = null, greens:Object = null, cyans:Object = null, blues:Object = null, magentas:Object = null, whites:Object = null, neutrals:Object = null, blacks:Object = null):void

Parameters

selectionMethod:AdjustmentReference — (com.adobe.photoshop.AdjustmentReference)
 
reds:Object (default = null) — (Object) Array of 4 values: cyan, magenta, yellow, black
 
yellows:Object (default = null) — (Object) Array of 4 values: cyan, magenta, yellow, black
 
greens:Object (default = null) — (Object) Array of 4 values: cyan, magenta, yellow, black
 
cyans:Object (default = null) — (Object) Array of 4 values: cyan, magenta, yellow, black
 
blues:Object (default = null) — (Object) Array of 4 values: cyan, magenta, yellow, black
 
magentas:Object (default = null) — (Object) Array of 4 values: cyan, magenta, yellow, black
 
whites:Object (default = null) — (Object) Array of 4 values: cyan, magenta, yellow, black
 
neutrals:Object (default = null) — (Object) Array of 4 values: cyan, magenta, yellow, black
 
blacks:Object (default = null) — (Object) Array of 4 values: cyan, magenta, yellow, black

shadowHighlight()method 
public function shadowHighlight(shadowAmount:Number = 50, shadowWidth:Number = 50, shadowRaduis:Number = 30, highlightAmount:Number = 0, highlightWidth:Number = 50, highlightRaduis:Number = 30, colorCorrection:Number = 20, midtoneContrast:Number = 0, blackClip:Number = 0.01, whiteClip:Number = 0.01):void

Adjusts the range of tones in the shadows and highlights.

Parameters

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

threshold()method 
public function threshold(level:Number):void

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.

Parameters

level:Number — (Number) The threshold level.